Introduction

• FAST SHIPPING AND

DELIVERY

• TENS OF THOUSANDS OF

IN-STOCK ITEMS

• EQUIPMENT DEMOS

• HUNDREDS OF

MANUFACTURERS

SUPPORTED

• LEASING/MONTHLY

RENTALS

• ITAR CERTIFIED

SECURE ASSET SOLUTIONS

Artisan Technology Group is your source for quality new and certified-used/pre-owned equipment

SERVICE CENTER REPAIRS

Experienced engineers and technicians on staff at our full-service, in-house repair center

Instra

View

SM

REMOTE INSPECTION

Remotely inspect equipment before purchasing with our interactive website at

www.instraview.com

WE BUY USED EQUIPMENT

Sell your excess, underutilized, and idle used equipment

We also offer credit for buy-backs and trade-ins

www.artisantg.com/WeBuyEquipment

LOOKING FOR MORE INFORMATION?

Visit us on the web at

www.artisantg.com

for more information on price quotations, drivers, technical specifications, manuals, and documentation

Contact us:

(888) 88-SOURCE | [email protected] | www.artisantg.com

Logix5000 Controllers General

Instructions

Reference Manual

Catalog Numbers 1756-L1x, 1756-

L5x, 1756-L6x, 1768-L4x, 1769-L30,

1769-L31, 1769-L32C, 1769-L32E,

1769-L35CR, 1769-L35E, 1789-L60,

1794-L34, 20D

Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Important User Information

Solid state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the

Application, Installation and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office or online at http://literature.rockwellautomation.com

) describes some important differences between solid state equipment and hardwired electromechanical devices. Because of this difference, and also because of the wide variety of uses for solid state equipment, all persons responsible for applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.

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.

IMPORTANT

ATTENTION

Identifies information that is critical for successful application and understanding of the product.

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

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.

Allen-Bradley, 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

Logix5000 Controllers General

Instructions

FactoryTalk Alarms and Events

Logix-based Instructions

(ALMD, ALMA)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Who Should Use This Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Purpose of This Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Common Information for All Instructions. . . . . . . . . . . . . . . . . . . . . . 25

Conventions and Related Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Set and clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Relay ladder rung condition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Function block states. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Chapter 1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Digital Alarm (ALMD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

State Diagrams when Acknowledgement Required . . . . . . . . . . . . 36

State Diagrams when Acknowledgment Not Required . . . . . . . . . 37

ALMD Alarm Acknowledge Required and Latched . . . . . . . . . . . 38

ALMD Alarm Acknowledge Required and Not Latched . . . . . . . 39

ALMD Alarm Acknowledge Not Required and Latched . . . . . . . 39

ALMD Alarm Acknowledge Not Required and Not Latched . . . 40

Analog Alarm (ALMA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

State Diagrams when Acknowledgement Required . . . . . . . . . . . . 54

State Diagrams when Acknowledgement Not Required . . . . . . . . 55

ALMA Level Condition Acknowledge Required . . . . . . . . . . . . . . 58

ALMA Level Condition Acknowledge Not Required . . . . . . . . . . 59

ALMA Rate of Change Acknowledge Required . . . . . . . . . . . . . . 60

ALMA Rate of Change Acknowledge Not Required . . . . . . . . . . 61

Configure an Alarm Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Enter Alarm Message Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Message String Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Multiple Language Versions of Alarm Messages . . . . . . . . . . . . . . 68

Monitor Alarm Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Buffering Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Programmatically Access Alarm Information. . . . . . . . . . . . . . . . . . . . 70

Suppress or Disable Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Controller-based Alarm Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Controller Memory Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Scan Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

3 Publication 1756-RM003K-EN-P - July 2008


3

Table of Contents

4

Bit Instructions

(XIC, XIO, OTE, OTL, OTU, ONS,

OSR, OSF, OSRI, OSFI)

Timer and Counter Instructions

(TON, TOF, RTO, TONR, TOFR,

RTOR, CTU, CTD, CTUD, RES)

Input/Output Instructions

(MSG, GSV, SSV, IOT)

Chapter 2

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Examine If Closed (XIC). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Examine If Open (XIO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Output Energize (OTE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Output Latch (OTL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Output Unlatch (OTU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

One Shot (ONS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

One Shot Rising (OSR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

One Shot Falling (OSF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

One Shot Rising with Input (OSRI) . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

One Shot Falling with Input (OSFI) . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Chapter 3

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Timer On Delay (TON). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Timer Off Delay (TOF). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Retentive Timer On (RTO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Timer On Delay with Reset (TONR) . . . . . . . . . . . . . . . . . . . . . . . . . 116

Timer Off Delay with Reset (TOFR) . . . . . . . . . . . . . . . . . . . . . . . . . 120

Retentive Timer On with Reset (RTOR) . . . . . . . . . . . . . . . . . . . . . . 124

Count Up (CTU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Count Down (CTD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Count Up/Down (CTUD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Reset (RES). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Chapter 4

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Message (MSG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

MSG Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Extended Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

PLC and SLC Error Codes (.ERR) . . . . . . . . . . . . . . . . . . . . . . . . 156

Block-Transfer Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Specify the Configuration Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Specify CIP Data Table Read and Write messages . . . . . . . . . . . 160

Reconfigure an I/O module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Specify CIP Generic messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Specify PLC-5 messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Specify SLC messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Specify block-transfer messages . . . . . . . . . . . . . . . . . . . . . . . . . . 165



MSG Configuration Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Specify the Communication Details . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Publication 1756-RM003K-EN-P - July 2008



Compare Instructions

(CMP, EQU, GEQ, GRT, LEQ, LES,

LIM, MEQ, NEQ)

Specify a path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

For Block Transfers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Specify a Communication Method Or Module Address . . . . . . . 172

Choose a cache option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Get System Value (GSV) and Set System Value (SSV) . . . . . . . . . . . 176

GSV/SSV Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Access the CONTROLLER object . . . . . . . . . . . . . . . . . . . . . . . 180

Access the CONTROLLERDEVICE object . . . . . . . . . . . . . . . 181

Access the CST object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Access the DF1 object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Access the FAULTLOG object . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Access The MESSAGE Object . . . . . . . . . . . . . . . . . . . . . . . . . . 188

Access The MODULE Object . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Access The MOTIONGROUP Object . . . . . . . . . . . . . . . . . . . . 191

Access The PROGRAM Object . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Access The Routine object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Access The SERIALPORT Object. . . . . . . . . . . . . . . . . . . . . . . . 193

Access The TASK Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Access The WALLCLOCKTIME Object . . . . . . . . . . . . . . . . . . 197

GSV/SSV Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Get Fault Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Set Enable And Disable Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Immediate Output (IOT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Chapter 5

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Compare (CMP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

CMP expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Valid operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Format Expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Determine The Order of Operation . . . . . . . . . . . . . . . . . . . . . . . 209

Use Strings In an Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Equal to (EQU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Greater than or Equal to (GEQ). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Greater Than (GRT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Less Than or Equal to (LEQ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Less Than (LES). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Limit (LIM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Mask Equal to (MEQ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Entering an Immediate Mask Value . . . . . . . . . . . . . . . . . . . . . . . 238

Not Equal to (NEQ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242



5


6

Compute/Math Instructions

(CPT, ADD, SUB, MUL, DIV, MOD,

SQR, SQRT, NEG, ABS)

Chapter 6

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Compute (CPT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Valid operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250


Determine the order of operation. . . . . . . . . . . . . . . . . . . . . . . . . 251

Add (ADD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

Subtract (SUB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Multiply (MUL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Divide (DIV) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Modulo (MOD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Square Root (SQR). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

Negate (NEG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Absolute Value (ABS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Move/Logical Instructions

(MOV, MVM, BTD, MVMT, BTDT,

CLR, SWPB, AND, OR, XOR, NOT,

BAND, BOR, BXOR, BNOT)

Chapter 7

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

Move (MOV) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

Masked Move (MVM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

Enter an immediate mask value . . . . . . . . . . . . . . . . . . . . . . . . . . 286

Masked Move with Target (MVMT) . . . . . . . . . . . . . . . . . . . . . . . . . . 288

Bit Field Distribute (BTD). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

Bit Field Distribute with Target (BTDT) . . . . . . . . . . . . . . . . . . . . . . 294

Clear (CLR). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Swap Byte (SWPB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Bitwise AND (AND) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

Bitwise OR (OR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Bitwise Exclusive OR (XOR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

Bitwise NOT (NOT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

Boolean AND (BAND). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

Boolean OR (BOR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

Boolean Exclusive OR (BXOR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Boolean NOT (BNOT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

Array (File)/Misc. Instructions

(FAL, FSC, COP, CPS, FLL, AVE,

SRT, STD, SIZE)

Chapter 8

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

Selecting Mode of Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

All mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

Numerical mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

Incremental mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

File Arithmetic and Logic (FAL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

FAL Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

Valid operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344






Array (File)/Shift Instructions

(BSL, BSR, FFL, FFU, LFL, LFU)

Sequencer Instructions

(SQI, SQO, SQL)

Program Control Instructions

(JMP, LBL, JSR, RET, SBR, JXR,

TND, MCR, UID, UIE, AFI,

NOP, EOT, SFP, SFR, EVENT)

File Search and Compare (FSC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

FSC expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Valid Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352



Use Strings In an Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

Copy File (COP) Synchronous Copy File (CPS) . . . . . . . . . . . . . . . . 355

File Fill (FLL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

File Average (AVE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

File Sort (SRT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

File Standard Deviation (STD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Size In Elements (SIZE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

Chapter 9

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

Bit Shift Left (BSL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

Bit Shift Right (BSR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

FIFO Load (FFL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

FIFO Unload (FFU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

LIFO Load (LFL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

LIFO Unload (LFU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Chapter 10

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

Sequencer Input (SQI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

Enter an Immediate Mask Value. . . . . . . . . . . . . . . . . . . . . . . . . . 421

Use SQI without SQO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

Sequencer Output (SQO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

Enter an Immediate Mask Value. . . . . . . . . . . . . . . . . . . . . . . . . . 425

Using SQI with SQO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

Resetting the position of SQO . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

Sequencer Load (SQL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

Chapter 11

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

Jump to Label (JMP)

Label (LBL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

Jump to Subroutine (JSR)

Subroutine (SBR) Return (RET) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

Jump to External Routine (JXR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

Temporary End (TND) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

Master Control Reset (MCR). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

User Interrupt Disable (UID) User Interrupt Enable (UIE) . . . . . . . 454

Always False Instruction (AFI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

No Operation (NOP). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457



7


For/Break Instructions

(FOR, FOR...DO, BRK, EXIT, RET)

Special Instructions

(FBC, DDT, DTR, PID)

End of Transition (EOT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

SFC Pause (SFP). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

SFC Reset (SFR). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

Trigger Event Task (EVENT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

Programmatically Determine if an EVENT Instruction Triggered a Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

Chapter 12

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

For (FOR). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

Break (BRK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

Return (RET) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Chapter 13

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

File Bit Comparison (FBC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

Selecting the Search Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

Diagnostic Detect (DDT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486

Selecting the search mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488

Data Transitional (DTR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

Enter an immediate mask value . . . . . . . . . . . . . . . . . . . . . . . . . . 495

Proportional Integral Derivative (PID). . . . . . . . . . . . . . . . . . . . . . . . 497

Configure a PID Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

Specify Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503

Specify Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

Specifying Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

Specifying Scaling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

Using PID Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

Anti-reset Windup And Bumpless Transfer From Manual To Auto

507

PID instruction timing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508

Bumpless Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

Derivative Smoothing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

Set the Deadband. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

Use Output Limiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

Feedforward or Output Biasing . . . . . . . . . . . . . . . . . . . . . . . . . . 515

Cascading Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

Control a Ratio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

PID Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

PID Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

PID Process With Master/slave Loops . . . . . . . . . . . . . . . . . . . . 517

8




Trigonometric Instructions

(SIN, COS, TAN, ASN, ASIN, ACS,

ACOS, ATN, ATAN)

Chapter 14

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

Sine (SIN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

Cosine (COS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

Tangent (TAN). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

Arc Sine (ASN). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

Arc Cosine (ACS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532

Arc Tangent (ATN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

Advanced Math Instructions

(LN, LOG, XPY)

Math Conversion Instructions

(DEG, RAD, TOD, FRD, TRN,

TRUNC)

Chapter 15

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539

Natural Log (LN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

Log Base 10 (LOG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543

X to the Power of Y (XPY) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546

Chapter 16

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549

Degrees (DEG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550

Radians (RAD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553

Convert to BCD (TOD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556

Convert to Integer (FRD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559

Truncate (TRN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561

ASCII Serial Port Instructions

(ABL, ACB, ACL, AHL, ARD, ARL,

AWA, AWT)

Chapter 17

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565

Instruction Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566

ASCII Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568

String Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568

ASCII Test For Buffer Line (ABL) . . . . . . . . . . . . . . . . . . . . . . . . . . . 570

ASCII Chars in Buffer (ACB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573

ASCII Clear Buffer (ACL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575

ASCII Handshake Lines (AHL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577

ASCII Read (ARD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581

ASCII Read Line (ARL). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585

ASCII Write Append (AWA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589

ASCII Write (AWT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594

ASCII String Instructions

(CONCAT, DELETE, FIND, INSERT,

MID)

Chapter 18

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599


String Concatenate (CONCAT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601

String Delete (DELETE). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603

Find String (FIND) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605

Insert String (INSERT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607



9


Middle String (MID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609

ASCII Conversion Instructions

(STOD, STOR, DTOS, RTOS, UPPER,

LOWER)

Chapter 19

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611


String To DINT (STOD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614

String To REAL (STOR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616

DINT to String (DTOS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619

REAL to String (RTOS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621

Upper Case (UPPER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623

Lower Case (LOWER). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625

Debug Instructions

(BPT, TPT)

Common Attributes

Function Block Attributes

Chapter 20

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627

Breakpoints (BPT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627

String Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628

Tracepoints (TPT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631

String Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631

Appendix A

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635

Immediate Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635

Data Conversions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635

SINT or INT to DINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637

Integer to REAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639

DINT to SINT or INT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639

REAL to an Integer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640

Appendix B

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641

Choose the Function Block Elements . . . . . . . . . . . . . . . . . . . . . . . . 641

Latching Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642

Order of Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644

Resolve a Loop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645

Resolve Data Flow Between Two Blocks. . . . . . . . . . . . . . . . . . . 647

Create a One Scan Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647

Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648

Function Block Responses to Overflow Conditions . . . . . . . . . . . . . 648

Timing Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649

Common Instruction Parameters for Timing Modes . . . . . . . . . 651

Overview of Timing Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653

Program/Operator Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654

10



Structured Text Programming

Index


Appendix C

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659

Structured Text Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659

Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661

Specify a non-retentive assignment. . . . . . . . . . . . . . . . . . . . . . . . 662

Assign an ASCII character to a string. . . . . . . . . . . . . . . . . . . . . . 663

Expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663

Use arithmetic operators and functions . . . . . . . . . . . . . . . . . . . . 665

Use relational operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666

Use logical operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668

Use bitwise operators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669

Determine the order of execution. . . . . . . . . . . . . . . . . . . . . . . . . 669

Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670

Constructs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671

Some key words are reserved for future use. . . . . . . . . . . . . . . . . 671

IF...THEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672

CASE...OF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675

FOR…DO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678

WHILE…DO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681

REPEAT…UNTIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684

Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687

ASCII Character Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699



11


12



Summary of Changes

Introduction

Updated Information

This release of this document contains new and updated information. To find new and updated information, look for change bars, as shown next to this paragraph.

This document contains the following changes:

Change

Chapter 1 — Combined Digital Alarm (ALMD) and Analog Alarm

(ALMA) instructions into one chapter. Added configuration, message string, and status information.

Chapter 4 — Added new GSV/SSV Controller Object attributes.

Chapter 20 — Added Debug Instructions (PPT, TPT).

Page

29

180

627



13

Summary of Changes

Notes:

14



Instruction Locator

If the locator lists:

a page number motion

PhaseManager process control

Where to Find an Instruction

Use this locator to find the reference details about Logix instructions (the grayed-out instructions are available in other manuals). This locator also lists which programming languages are available for the instructions.

The instruction is documented in:

this manual

Logix5000 Controllers Motion Instruction Set Reference Manual,

publication 1756-RM007

PhaseManager User Manual, publication LOGIX-UM001

Logix5000 Controllers Process Control and Drives Instruction Set

Reference Manual, publication 1756-RM006



15

Instruction Locator

Instruction:

ABL

ASCII Test For Buffer Line

ABS

Absolute Value

ACB

ASCII Chars in Buffer

ACL

ASCII Clear Buffer

ACS

Arc Cosine

Location:

609

277

573

575

532

ADD

Add

AFI

Always False Instruction

AHL

ASCII Handshake Lines

ALM

Alarm

ALMA

Analog Alarm

ALMD

Digital Alarm

AND

Bitwise AND

ARD

ASCII Read

ARL

ASCII Read Line

ASN

Arc Sine

ATN

Arc Tangent

AVE

File Average

AWA

ASCII Write Append

AWT

ASCII Write

BAND

Boolean AND

252

456

589

594

317

577 process control structured text function block

42 relay ladder structured text

30

303

581 relay ladder structured text function block relay ladder structured text function block relay ladder structured text function block relay ladder structured text

585

529

535

365 relay ladder structured text relay ladder structured text function block relay ladder structured text function block relay ladder relay ladder structured text relay ladder structured text structured text function block

Languages:

relay ladder structured text relay ladder structured text function block relay ladder structured text relay ladder structured text relay ladder structured text function block relay ladder structured text function block relay ladder

16

Instruction:

BNOT

Boolean NOT

BOR

Boolean OR

BPT

Breakpoints

BRK

Break

BSL

Bit Shift Left

BSR

Bit Shift Right

BTD

Bit Field Distribute

BTDT

Bit Field Distribute with

Target

BTR

Message

BTW

Message

BXOR

Boolean Exclusive OR

CC

Coordinated Control

CLR

Clear

CMP

Compare

CONCAT

String Concatenate

COP

Copy File

COS

Cosine

CPS

Synchronous Copy File

CPT

Compute

CTD

Count Down

CTU

Count Up

473

386

390

294

294

Location:

326

320

627

144

144 relay ladder structured text relay ladder structured text

323 structured text function block process control structured text function block


206 relay ladder

601

355

523

355

248 relay ladder structured text relay ladder structured text relay ladder structured text function block relay ladder structured text relay ladder

132

128 relay ladder relay ladder

Languages:

structured text function block structured text function block relay ladder relay ladder relay ladder relay ladder relay ladder structured text function block



Instruction:

CTUD

Count Up/Down

D2SD

Discrete 2-State Device

D3SD

Discrete 3-State Device

DDT

Diagnostic Detect

DEDT

Deadtime

DEG

Degrees

DELETE

String Delete

DERV

Derivative

DFF

D Flip-Flop

DIV

Divide

DTOS

DINT to String

DTR

Data Transitional

EOT

End of Transition

EQU

Equal to

ESEL

Enhanced Select

EVENT

Trigger Event Task

FAL

File Arithmetic and Logic

FBC

File Bit Comparison

FFL

FIFO Load

FFU

FIFO Unload

FGEN

Function Generator

Location:

136

Languages:

structured text function block process control structured text function block process control structured text function block

486 relay ladder process control structured text function block

553

603 relay ladder structured text function block relay ladder structured text process control structured text function block process control structured text function block

261

619

494 relay ladder structured text function block relay ladder structured text relay ladder

458

206 relay ladder structured text function block process control structured text function block

464 relay ladder structured text relay ladder structured text

335 relay ladder relay ladder 478

394 relay ladder

400 relay ladder process control structured text function block


Instruction:

FIND

Find String

FLL

File Fill

FOR

For

FRD

Convert to Integer

FSC

File Search and Compare

GEQ

Greater than or Equal to

GRT

Greater Than

GSV

Get System Value

HLL

High/Low Limit

HPF

High Pass Filter

ICON

Input Wire Connector

IMC

Internal Model Control

INSERT

Insert String

INTG

Integrator

IOT

Immediate Output

IREF

Input Reference

JKFF

JK Flip-Flop

JMP

Jump to Label

JSR

Jump to Subroutine

JXR

Jump to External Routine

LBL

Label

Location:

605

361

470

559

346

Languages:

relay ladder structured text relay ladder relay ladder relay ladder function block relay ladder

215

219

176 relay ladder structured text function block relay ladder structured text function block relay ladder structured text process control structured text function block process control structured text function block

641 function block process control structured text function block

607 relay ladder structured text process control structured text function block


641 function block process control structured text function block

434 relay ladder

436 relay ladder structured text function block relay ladder 447

434 relay ladder



17


Instruction:

LDL2

Second-Order Lead Lag

LDLG

Lead-Lag

LEQ

Less Than or Equal to

LES

Less Than

LFL

LIFO Load

LFU

LIFO Unload

LIM

Limit

LN

Natural Log

LOG

Log Base 10

LOWER

Lower Case

LPF

Low Pass Filter

MAAT

Motion Apply Axis Tuning

MAFR

Motion Axis Fault Reset

MAG

Motion Axis Gear

MAHD

Motion Apply Hookup

Diagnostics

MAH

Motion Axis Home

MAJ

Motion Axis Jog

MAM

Motion Axis Move

MAOC

Motion Arm Output Cam

MAPC

Motion Axis Position Cam

MAR

Motion Arm Registration

Location: Languages:

process control structured text function block process control structured text function block

223

227

406 relay ladder structured text function block relay ladder structured text function block relay ladder

412 relay ladder

231

540

(1)

625 relay ladder function block relay ladder structured text function block relay ladder structured text function block relay ladder structured text process control structured text function block motion relay ladder structured text motion relay ladder structured text motion motion relay ladder structured text relay ladder structured text motion motion motion motion motion motion relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text

18

Instruction:

MCT

Motion Coordinated

Transform

MCTP

Motion Calculate Transform

Position

MDF

Motion Direct Drive Off

Location:

motion motion motion

Languages:

MASD

Motion Axis Shutdown

MAS

Motion Axis Stop relay ladder structured text

MASR

Motion Axis Shutdown Reset motion motion MATC

Motion Axis Time Cam

MAVE

Moving Average process control relay ladder structured text relay ladder structured text structured text function block

MAW

Motion Arm Watch

MAXC

Maximum Capture motion motion motion process control relay ladder structured text relay ladder structured text structured text function block

MCCD

Motion Coordinated Change

Dynamics motion

MCCM

Motion Coordinated Circular

Move motion

MCCP

Motion Calculate Cam Profile motion motion MCD

Motion Change Dynamics

MCLM

Motion Coordinated Linear

Move motion

452 MCR

Master Control Reset

MCSD

Motion Coordinated

Shutdown

MCS

Motion Coordinated Stop

MCSR

Motion Coordinated

Shutdown Reset motion motion motion relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text




Instruction:

MDOC

Motion Disarm Output Cam

MDO

Motion Direct Drive On

MDR

Motion Disarm Registration

MDW

Motion Disarm Watch

MEQ

Mask Equal to

Location:

motion motion motion motion

237

MGSD

Motion Group Shutdown

MGS

Motion Group Stop

MGSP

Motion Group Strobe

Position

MGSR

Motion Group Shutdown

Reset

MID

Middle String

MINC

Minimum Capture

IMMC

Modular Multivariable

Control

MOD

Modulo

MOV

Move

MRAT

Motion Run Axis Tuning

MRHD

Motion Run Hookup

Diagnostics

MRP

Motion Redefine Position

MSF

Motion Servo Off

MSG

Message

MSO

Motion Servo On motion motion motion motion

609

266

283 motion motion motion motion

144 motion

Languages:

relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text function block relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text process control structured text function block process control structured text function block relay ladder structured text function block relay ladder relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text

Instruction:

MSTD

Moving Standard Deviation

MUL

Multiply


process control structured text function block

258 relay ladder structured text function block process control function block MUX

Multiplexer

MVM

Masked Move

MVMT

Masked Move with Target

NEG

Negate

NEQ

Not Equal to

285

288

274

242

457 relay ladder structured text function block relay ladder structured text function block relay ladder structured text function block relay ladder NOP

No Operation

NOT

Bitwise NOT

NTCH

Notch Filter

OCON

Output Wire Connector

ONS

One Shot

OR

Bitwise OR


641 function block

88

306 relay ladder relay ladder structured text function block function block OREF

Output Reference

OSFI

One Shot Falling with Input

OSF

One Shot Falling

OSRI

One Shot Rising with Input

OSR

One Shot Rising

OTE

Output Energize

OTL

Output Latch

OTU

Output Unlatch

641

99

94

91

91

82

84

86 structured text function block relay ladder structured text function block relay ladder relay ladder relay ladder relay ladder



19


Instruction:

PATT

Attach to Equipment Phase

PCLF

Equipment Phase Clear

Failure

PCMD

Equipment Phase Command

PDET

Detach from Equipment

Phase

PFL

Equipment Phase Failure

PIDE

Enhanced PID

PID

Proportional Integral

Derivative

PI

Proportional + Integral

PMUL

Pulse Multiplier

POSP

Position Proportional

POVR

Equipment Phase Override

Command

PPD

Equipment Phase Paused

PRNP

Equipment Phase New

Parameters

PSC

Phase State Complete

PXRQ

Equipment Phase External

Request

RAD

Radians

Location:

PhaseManager

PhaseManager

Languages:

PhaseManager relay ladder structured text relay ladder structured text

PhaseManager relay ladder

PhaseManager relay ladder process control structured text

497 process control function block relay ladder structured text structured text function block process control structured text function block process control structured text function block

PhaseManager relay ladder structured text

PhaseManager

PhaseManager relay ladder

PhaseManager relay ladder structured text structured text structured text relay ladder structured text structured text relay ladder structured text

PhaseManager relay ladder structured text

RESD

Reset Dominant

RES

Reset

RET

Return


141 relay ladder

436 and 474 relay ladder structured text function block

20

SCL

Scale

SCRV

S-Curve

SEL

Select

SETD

Set Dominant

SFP

SFC Pause

SFR

SFC Reset

SIN

Sine

Instruction:

RLIM

Rate Limiter

RMPS

Ramp/Soak

RTO

Retentive Timer On

RTOR

Retentive Timer On with

Reset

RTOS

REAL to String

SBR

Subroutine

SIZE

Size In Elements

SNEG

Selected Negate

SOC

Second-Order Controller

SQI

Sequencer Input

SQL

Sequencer Load

SQO

Sequencer Output

SQR

Square Root

SQRT

Square Root


process control structured text function block process control structured text function block

112 relay ladder

124 structured text function block


436 relay ladder structured text function block process control structured text function block process control structured text function block process control function block process control structured text function block


462

520

381 relay ladder structured text relay ladder structured text function block relay ladder structured text process control structured text function block process control structured text function block

420 relay ladder relay ladder 428

424 relay ladder

270

270 relay ladder function block structured text




Instruction:

SRT

File Sort

SRTP

Split Range Time

Proportional

SSUM

Selected Summer

SSV

Set System Value

STD

File Standard Deviation

STOD

String To DINT

STOR

String To REAL

SUB

Subtract

SWPB

Swap Byte

TAN

Tangent

TND

Temporary End

TOD

Convert to BCD

TOFR

Timer Off Delay with Reset

TOF

Timer Off Delay

TONR

Timer On Delay with Reset

TON

Timer On Delay

TOT

Totalizer

TPT

Tracepoints

TRN

Truncate

TRUNC

Truncate

UID

User Interrupt Disable

Location:

370

Languages:

relay ladder structured text process control structured text function block process control structured text function block

176

375

614

616

255

299

526

450

556

120

108

116

104 process control

631

561

561

454 relay ladder structured text relay ladder relay ladder structured text relay ladder structured text relay ladder structured text function block relay ladder structured text relay ladder structured text function block relay ladder relay ladder function block structured text function block relay ladder structured text function block relay ladder structured text function block relay ladder relay ladder function block structured text relay ladder structured text

Instruction:

UIE

User Interrupt Enable

UPDN

Up/Down Accumulator

UPPER

Upper Case

XIC

Examine If Closed

XIO

Examine If Open

XOR

Bitwise Exclusive OR

XPY

X to the Power of Y

(1)

Location:

454

Languages:

relay ladder structured text process control structured text function block

623

78 relay ladder structured text relay ladder

80

310

546 relay ladder relay ladder structured text function block relay ladder structured text function block



21


Notes:

22



Preface

Logix5000 Controllers General Instructions

Introduction

This manual is one of several Logix5000-based instruction manuals.

Task/Goal

Program the controller for sequential applications

You are here

Documents

Logix5000 Controllers General Instructions Reference Manual, publication

1756-RM003

Program the controller for process or drives applications

Program the controller for motion applications

Program the controller to use equipment phases

Import a text file or tags into a project

Export a project or tags to a text file

Convert a PLC-5 or SLC 500 application to a

Logix5000 application

Logix5000 Controllers Process Control and Drives Instructions Reference Manual, publication 1756-RM006

Logix5000 Controllers Motion Instruction Set Reference Manual, publication

1756-RM007

PhaseManager User Manual, publication LOGIX-UM001

Logix5000 Controllers Import/Export Reference Manual, publication 1756-RM084

Logix5550 Controller Converting PLC-5 or SLC 500 Logic to Logix5550 Logic Reference

Manual, publication 1756-6.8.5

Who Should Use

This Manual

This document provides a programmer with details about each available instruction for a Logix-based controller. You should already be familiar with how the Logix-based controller stores and processes data.

Novice programmers should read all the details about an instruction before using the instruction. Experienced programmers can refer to the instruction information to verify details.



23

Preface Logix5000 Controllers General Instructions

Purpose of This Manual

This section

Instruction name

Operands

Instruction structure

Description

Arithmetic status flags

Fault conditions

Execution

Example

This manual provides a description of each instruction in this format.

Provides this type of information

identifies the instruction defines whether the instruction is an input or an output instruction lists all the operands of the instruction if available in relay ladder, describes the operands if available in structured text, describes the operands if available in function block, describes the operands

The pins shown on a default function block are only the default pins. The operands table lists all the possible pins for a function block.

lists control status bits and values, if any, of the instruction describes the instruction’s use defines any differences when the instruction is enabled and disabled, if appropriate defines whether or not the instruction affects arithmetic status flags see appendix Common Attributes defines whether or not the instruction generates minor or major faults if so, defines the fault type and code defines the specifics of how the instruction operates provides at least one programming example in each available programming language includes a description explaining each example

The following icons help identify language specific information:

This icon Indicates this programming language

relay ladder structured text function block

24



Logix5000 Controllers General Instructions Preface

Common Information for

All Instructions

The Logix5000 instruction set has some common attributes:

For this information

common attributes function block attributes

See this appendix

appendix Common Attributes defines:

• arithmetic status flags

• data types

• keywords appendix Function Block Attributes defines:

• program and operator control

• timing modes

Conventions and

Related Terms

Set and clear

This manual uses set and clear to define the status of bits (booleans) and values (non-booleans):

This term

set clear

Means

the bit is set to 1 (ON) a value is set to any non-zero number the bit is cleared to 0 (OFF) all the bits in a value are cleared to 0

If an operand or parameter support more than one data type, the bold data types indicate optimal data types. An instruction executes faster and requires less memory if all the operands of the instruction use the same optimal data type, typically DINT or REAL.



25


Relay ladder rung condition

The controller evaluates ladder instructions based on the rung condition preceding the instruction (rung-condition-in). Based on the rung-condition-in and the instruction, the controller sets the rung condition following the instruction (rung-condition-out), which in turn, affects any subsequent instruction.

input instruction output instruction rung-in condition rung-out condition

If the rung-in condition to an input instruction is true, the controller evaluates the instruction and sets the rung-out condition based on the results of the instruction. If the instruction evaluates to true, the rung-out condition is true; if the instruction evaluates to false, the rung-out condition is false.

The controller also prescans instructions. Prescan is a special scan of all routines in the controller. The controller scans all main routines and subroutines during prescan, but ignores jumps that could skip the execution of instructions. The controller executes all FOR loops and subroutine calls. If a subroutine is called more than once, it is executed each time it is called. The controller uses prescan of relay ladder instructions to reset non-retentive I/O and internal values.

During prescan, input values are not current and outputs are not written. The following conditions generate prescan:

•

Toggle from Program to Run mode

•

Automatically enter Run mode from a power-up condition.

Prescan does not occur for a program when:

•

The program becomes scheduled while the controller is running.

•

The program is unscheduled when the controller enters Run mode.

26



Logix5000 Controllers General Instructions Preface

Function block states

Possible Condition

prescan instruction first scan instruction first run

IMPORTANT

When programming in function block, restrict the range of engineering units to

+/-10

+/-15

because internal floating point calculations are done using single precision floating point. Engineering units outside of this range may result in a loss of accuracy if results approach the limitations of single precision floating point

(+/-10

+/-38

).

The controller evaluates function block instructions based on the state of different conditions.

Description

Prescan for function block routines is the same as for relay ladder routines. The only difference is that the

EnableIn parameter for each function block instruction is cleared during prescan.

Instruction first scan refers to the first time an instruction is executed after prescan. The controller uses instruction first scan to read current inputs and determine the appropriate state to be in.

Instruction first run refers to the first time the instruction executes with a new instance of a data structure.

The controller uses instruction first run to generate coefficients and other data stores that do not change for a function block after initial download.

Every function block instruction also includes EnableIn and EnableOut parameters:

• function block instructions execute normally when EnableIn is set.

• when EnableIn is cleared, the function block instruction either executes prescan logic, postscan logic, or just skips normal algorithm execution.

•

EnableOut mirrors EnableIn, however, if function block execution detects an overflow condition EnableOut is also cleared.

• function block execution resumes where it left off when EnableIn toggles from cleared to set. However there are some function block instructions that specify special functionality, such as re-initialization, when EnableIn toggles from cleared to set. For function block instructions with time base parameters, whenever the timing mode is

Oversample, the instruction always resumes were it left off when

EnableIn toggles from cleared to set.

If the EnableIn parameter is not wired, the instruction always executes as normal and EnableIn remains set. If you clear EnableIn, it changes to set the next time the instruction executes.



27


Notes:

28



Chapter

1

FactoryTalk Alarms and Events Logix-based

Instructions

(ALMD, ALMA)

Introduction

These Logix-based alarm instructions are available in relay ladder, structured text, and function block diagram. When used with FactoryTalk View SE software, version 5.0 and later, these instructions create an alarming system with your visualization package. The controller detects alarm conditions and publishes events to FactoryTalk View Alarms and Events servers that propagate alarms to Factory Talk View SE clients that subscribe to receive notifications.

If You Want To

detect alarms based on Boolean (true/false) conditions

Use This Instruction

ALMD detect alarms based on the level or rate of change of a value

ALMA

Available In These Languages

relay ladder structured text function block relay ladder structured text function block

See Page

30

42



29

Chapter 1 FactoryTalk Alarms and Events Logix-based Instructions (ALMD, ALMA)

Digital Alarm (ALMD)

Operands:

The ALMD instruction detects alarms based on Boolean (true/false) conditions. Program (Prog) and operator (Oper) control parameters provide an interface for alarm commands.

Relay Ladder

In relay ladder, the alarm condition input (In) is obtained from the rung condition.

30

Operand

ALMD tag

In

ProgAck

ProgReset

ProgDisable

ProgEnable

MinDurationPRE

MinDurationACC

Type

ALARM_DIGITAL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

ALMD(ALMD, In, ProgAck,

ProgReset, ProgDisable,

ProgEnable);

Format

Structure

Tag

Immediate

Tag

Immediate

Tag

Immediate

Tag

Immediate

Tag

Immediate

Immediate

Immediate

Description

ALMD structure.

Structured text only.

Value is copied to In when instruction executes. The alarm input value is compared to determine whether there is an alarm.

Value is copied to ProgAck when instruction executes. On transition from cleared to set, acknowledges alarm (if acknowledgement is required).

Value is copied to ProgReset when instruction executes. On transition from cleared to set, resets alarm (if required).

Value is copied to ProgDisable when instruction executes.

When set, disables alarm (does not override Enable

Commands).

Value is copied to ProgEnable when instruction executes.

When set, enables alarm (takes precedence over Disable

Commands).

Relay ladder only.

Specifies how long the alarm condition must be met before it is reported (milliseconds).


Indicates the number of milliseconds that have elapsed since the alarm condition was met.

Structured Text

The operands are the same as those for the relay ladder ALMD instruction, with a few exceptions as indicated above.



FactoryTalk Alarms and Events Logix-based Instructions (ALMD, ALMA) Chapter 1

Function Block

Operand Type

ALMD tag ALARM_DIGITAL

Format

Structure

Description

ALMD structure

Input Parameter

EnableIn

Data Type

BOOL

In

InFault

Condition

BOOL

BOOL

BOOL

ALARM_DIGITAL Structure

Description

Relay Ladder:

Corresponds to the rung state. Does not affect processing.

Function Block:

If cleared, the instruction does not execute and outputs are not updated.

If set, the instruction executes.

Default is set.

Structured Text:

No effect. The instruction always executes.

The digital signal input to the instruction.

Default is cleared.

Relay Ladder:

Follows the rung condition. Set if the rung condition is true. Cleared if the rung condition is false.


Copied from instruction operand.

Bad health indicator for the input. The user application may set InFault to indicate the input signal has an error. When set, the instruction sets InFaulted (Status.1). When cleared, the instruction clears InFaulted (Status.1). In either case, the instruction continues to evaluate In for alarm conditions.

Default is cleared (good health).

Specifies how alarm is activated. When Condition is set, the alarm condition is activated when In is set. When Condition is cleared, the alarm condition is activated when In is cleared.

Default is set.

Publication 1756-RM003K-EN-P - July 2008 Year


31


Input Parameter

AckRequired

Data Type

BOOL

Latched

ProgAck

OperAck

ProgReset

OperReset

ProgSuppress

OperSuppress

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

Description

Specifies whether alarm acknowledgement is required. When set, acknowledgement is required. When cleared, acknowledgement is not required and Acked is always set.

Default is set.

Specifies whether the alarm is latched. Latched alarms remain InAlarm when the alarm condition becomes false, until a Reset command is received. When set, the alarm is latched.

When cleared, the alarm is unlatched.

A latched alarm can only be reset when the alarm condition is false.

Default is cleared.

Set by the user program to acknowledge the alarm. Requires a cleared-to-set transition while the alarm is unacknowledged.

Default is cleared.

Relay Ladder:

Copied from the instruction operand.



Set by the operator interface to acknowledge the alarm. Requires a cleared-to-set transition while the alarm is unacknowledged. The instruction clears this parameter.

Default is cleared.

Set by the user program to reset the alarm. Requires a cleared-to-set transition while the alarm is InAlarm and the In condition is not in alarm.

Default is cleared.

Relay Ladder:




Set by the operator interface to reset the alarm. Requires a cleared-to-set transition while the alarm is InAlarm and the In condition is not in alarm. The alarm instruction clears this parameter.

Default is cleared.

Set by the user program to suppress the alarm.

Default is cleared.

Set by the operator interface to suppress the alarm. The alarm instruction clears this parameter.

Default is cleared.

32




Input Parameter

ProgUnsuppress

Data Type

BOOL

OperUnsuppress

ProgDisable

OperDisable

ProgEnable

OperEnable

AlarmCountReset

UseProgTime

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

Description

Set by the user program to unsuppress the alarm. Takes precedence over Suppress commands.

Default is cleared.

Set by the operator interface to unsuppress the alarm. Takes precedence over Suppress commands. The alarm instruction clears this parameter.

Default is cleared.

Set by the user program to disable the alarm.

Default is cleared.

Relay Ladder:




Set by the operator interface to disable the alarm. The alarm instruction clears this parameter.

Default is cleared.

Set by the user program to enable the alarm. Takes precedence over a Disable command.

Default is cleared.

Relay Ladder:




Set by the operator interface to enable the alarm. Takes precedence over Disable command.

The alarm instruction clears this parameter.

Default is cleared.

Set by the user program to reset the alarm count. A cleared-to-set transition resets the alarm count to zero.

Default is cleared.

Specifies whether to use the controller’s clock or the ProgTime value to timestamp alarm state change events. When set, the ProgTime value provides timestamp. When cleared, the controller’s clock provides timestamp.

Default is cleared.



33


Input Parameter

ProgTime

Data Type

LINT

Severity DINT

MinDurationPRE DINT

Description

If UseProgTime is set, this value is used to provide the timestamp value for all events. This lets the application apply timestamps obtained from the alarm source, such as a sequence-of-events input module.

Severity of the alarm. This does not affect processing of alarms by the controller, but can be used for sorting and filtering functions at the alarm subscriber.

Valid = 1...1000 (1000 = most severe; 1 = least severe).

Default = 500.

Minimum duration preset (milliseconds) for the alarm condition to remain true before the alarm is marked as InAlarm and alarm notification is sent to clients. The controller collects alarm data as soon as the alarm condition is detected, so no data is lost while waiting to meet the minimum duration.

Valid = 0...2,147,483,647.

Default = 0.

Output Parameter

EnableOut

InAlarm

Acked

Data Type

BOOL

BOOL

BOOL

InAlarmUnack

Suppressed

Disabled

MinDurationACC

AlarmCount

BOOL

BOOL

BOOL

DINT

DINT

InAlarmTime

AckTime

LINT

LINT

RetToNormalTime LINT

AlarmCountResetTime LINT

DeliveryER BOOL

Description

Enable output.

Alarm active status. Set when the alarm is active. Cleared when the alarm is not active

(normal status).

Alarm acknowledged status. Set when the alarm is acknowledged. Cleared when the alarm is not acknowledged.

Acked is always set when AckRequired is cleared.

Combined alarm active and acknowledged status. Set when the alarm is active (InAlarm is set) and unacknowledged (Acked is cleared). Cleared when the alarm is normal (inactive), acknowledged, or both.

Suppressed status of the alarm. Set when the alarm is suppressed. Cleared when the alarm is not suppressed.

Disabled status of the alarm. Set when the alarm is disabled. Cleared when the alarm is enabled.

Elapsed time since the alarm was detected. When this value reaches MinDurationPRE, the alarm becomes active (InAlarm is set), and a notification is sent to clients.

Number of times the alarm has been activated (InAlarm is set). If the maximum value is reached, the counter leaves the value at the maximum count value.

Timestamp of alarm detection.

Timestamp of alarm acknowledgement. If the alarm does not require acknowledgement, this timestamp is equal to alarm time.

Timestamp of alarm returning to a normal state.

Timestamp indicating when the alarm count was reset.

Delivery error of the alarm notification message. Set when there is a delivery error: either no alarm subscriber was subscribed or at least one subscriber did not receive the latest alarm change state message. Cleared when delivery is successful or is in progress.

34





DeliveryDN

Data Type

BOOL

DeliveryEN

NoSubscriber

NoConnection

CommError

AlarmBuffered

Subscribers

SubscNotified

Status

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

DINT

InstructFault (Status.0) BOOL

InFaulted (Status.1) BOOL

SeverityInv (Status.2) BOOL

Description

Delivery completion of the alarm notification message. Set when delivery is successful: at least one subscriber was subscribed and all subscribers received the latest alarm change state message successfully. Cleared when delivery does not complete successfully or is in progress.

Delivery status of the alarm notification message. Set when delivery is in progress. Cleared when delivery is not in progress.

Alarm had no subscribers when attempting to deliver the most recent message. Set when there are no subscribers. Cleared when there is at least one subscriber.

Alarm’s subscribers were not connected when attempting to deliver the most recent message. Set when all subscribers are disconnected. Cleared when at least one subscriber is connected or there are no subscribers.

Communication error when delivering an alarm message. Set when there are communication errors and all retries are used. This means that a subscriber was subscribed and it had a connection, but the controller did not receive confirmation of message delivery. Cleared when all connected subscribers confirm receipt of the alarm message.

Alarm message buffered due to a communication error (CommError is set) or a lost connection (NoConnection is set). Set when the alarm message is buffered for at least one subscriber. Cleared when the alarm message is not buffered.

Number of subscribers for this alarm.

Number of subscribers successfully notified about the most recent alarm state change.

Combined status indicators:

Status.0 = InstructFault.

Status.1= InFaulted.

Status.2 = SeverityInv.

Instruction error conditions exist. This is not a minor or major controller error. Check the remaining status bits to determine what occurred.

User program has set InFault to indicate bad quality input data. Alarm continues to evaluate

In for alarm condition.

Alarm severity configuration is invalid.

If severity <1, the instruction uses Severity = 1.

If severity >1000, the instruction uses Severity = 1000.

Description

The ALMD instruction detects alarms based on Boolean (true/false) conditions.

The ALMD instruction provides additional functionality when used with

RSLinx Enterprise and FactoryTalk View SE software. You can display alarms in the Alarm Summary, Alarm Banner, Alarm Status Explorer, and Alarm Log

Viewer displays in FactoryTalk View SE software.



35


RSLinx Enterprise software subscribes to alarms in the controller. Use the output parameters to monitor the instruction to see the alarm subscription status and to display alarm status changes. If a connection to RSLinx

Enterprise software is lost, the controller can briefly buffer alarm data until the connection is restored.

State Diagrams when Acknowledgement Required

Latched = False

InAlarm = False

Acked = True

Ack

1

InAlarm = False

Acked = False

In = Condition, MinDurationACC >= MinDurationPRE

In

= C on diti on

, M inD ura tion

In !

= C ond itio n

AC

C >

In !=

= M inD ura tion

PR

E

Con ditio n

InAlarm = True

Acked = False

Ack

1

InAlarm = True

Acked = True

Latched = True

InAlarm = False

Acked = True


In != Condition, Reset

2

In !=

Co nditio n, Re set

2

InAlarm = True

Acked = False

Ack

1

InAlarm = True

Acked = True

1

Alarm can be acked by several different ways: ProgAck, OperAck, clients (RSLogix 5000 software, RSView software).

2

Alarm can be reset by several different ways: ProgReset, OperReset, clients (RSLogix 5000 software, RSView software).

36




State Diagrams when Acknowledgment Not Required

Latched = False


InAlarm = False InAlarm = True

In != Condition

Acked = True

Latched = True

InAlarm = False


In != Condition, Reset

1

InAlarm = True Acked = True

1

Alarm can be reset by several different ways: ProgReset, OperReset, clients (RSLogix 5000 software, RSView software)

Arithmetic Status Flags:

none

Fault Conditions:

none

Execution:

Condition

prescan rung-condition-in is false rung-condition-in is true postscan

Relay Ladder Action

The rung-condition-out is set to false.

InAlarm is cleared and Acked is set.

All operator requests, timestamps, and delivery flags are cleared.


EnableIn and EnableOut are cleared.

The In parameter is cleared, and the instruction evaluates to determine the alarm state.

The rung-condition-out is set to true.

EnableIn and EnableOut are set.

The In parameter is set, and the instruction evaluates to determine the alarm state.




37


Condition


EnableIn is cleared

EnableIn is set postscan

Function Block Action


Structured Text Action



No action taken.

No action taken.

The instruction does not execute.


No action taken.

No action taken.

The instruction executes.

EnableOut is cleared.


EnableOut is set.

No action taken.

EnableOut is always set.



No action taken.

ALMD Alarm Acknowledge Required and Latched

38




ALMD Alarm Acknowledge Required and Not Latched

ALMD Alarm Acknowledge Not Required and Latched



39


ALMD Alarm Acknowledge Not Required and Not Latched

Example:

Two motor failure signals are combined such that if either one occurs, a motor fault alarm is activated. Programmatically acknowledge the alarm with a cleared-to-set transition of the Motor101Ack tag value. The application logic must clear Motor101Ack.

Relay Ladder

40




Structured Text

Motor101FaultConditions := Motor101Overtemp OR

Motor101FailToStart;

ALMD(Motor101Fault,Motor101FaultConditions,Motor101Ack,

0,0,0 );

Function Block



41


Analog Alarm (ALMA)

The ALMA instruction detects alarms based on the level or rate of change of an analog value. Program (Prog) and operator (Oper) control parameters provide an interface for alarm commands.

Operands:

Relay Ladder

HHlimit

HLimit

LLimit

LLLimit

Operand

ALMA tag

In

ProgAckAll

ProgDisable

ProgEnable

REAL

REAL

REAL

REAL

Type

ALARM_ANALOG

REAL

DINT

INT

SINT

BOOL

Format

Structure

Tag

Immediate

BOOL

Tag

Immediate

Tag

Immediate

BOOL Tag

Immediate

Immediate

Immediate

Immediate

Immediate

Description

ALMA structure.

Value is copied to In when instruction executes. The alarm input value, which is compared with alarm limits to detect the alarm conditions.

Value is copied to ProgAckAll when instruction executes. On transition from cleared to set, acknowledges all alarm conditions that require acknowledgement.

Value is copied to ProgDisable when instruction executes.

When set, disables alarm (does not override Enable

Commands).

Value is copied to ProgEnable when instruction executes.

When set, enables alarm (takes precedence over Disable commands).


High High alarm limit.


High alarm limit.


Low alarm limit.


Low Low alarm limit.

42




Structured Text

ALMA(ALMA, In, ProgAckAll,

ProgDisable, ProgEnable);

The operands are the same as those for the relay ladder ALMD instruction, with a few exceptions as indicated above.

Function Block

Operand Type

ALMA tag ALARM_ANALOG

Format

Structure

Description

ALMA structure



43


Input Parameter

EnableIn

Data Type

BOOL

In

InFault

HHEnabled

HEnabled

LEnabled

LLEnabled

REAL

BOOL

BOOL

BOOL

BOOL

BOOL

ALARM_ANALOG Structure

Description

Relay Ladder:

Corresponds to the rung state. If cleared, the instruction does not execute and outputs are not updated.


No effect. The instruction always executes.

Function Block:


Default is set.

The alarm input value, which is compared with alarm limits to detect alarm conditions.

Default = 0.0.

Relay Ladder:



Copied from instruction operand.

Bad health indicator for the input. The user application may set InFault to indicate the input signal has an error. When set, the instruction sets InFaulted (Status.1). When cleared, the instruction clears InFaulted (Status.1). In either case, the instruction continues to evaluate In for alarm conditions.

Default is cleared (good health).

High High alarm condition detection. Set to enable detection of the High High alarm condition.

Clear to disable detection of the High High alarm condition.

Default is set.

High alarm condition detection. Set to enable detection of the High alarm condition. Clear to disable detection of the High alarm condition.

Default is set.

Low alarm condition detection. Set to enable detection of the Low alarm condition. Clear to disable detection of the Low alarm condition.

Default is set.

Low Low alarm condition detection. Set to enable detection of the Low Low alarm condition.

Clear to disable detection of the Low Low alarm condition.

Default is set.

44




Input Parameter

AckRequired

Data Type

BOOL

ProgAckAll

OperAckAll

HHProgAck

HHOperAck

HProgAck

HOperAck

LProgAck

LOperAck

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

Description

Specifies whether alarm acknowledgement is required. When set, acknowledgement is required. When cleared, acknowledgement is not required and HHAcked, HAcked, LAcked,

LLAcked, ROCPosAcked, and ROCNegAcked are always set.

Default is set.

Set by the user program to acknowledge all conditions of this alarm. Requires a cleared-to-set transition while the alarm conditions are unacknowledged.

Default is cleared.

Relay Ladder:




Set by the operator interface to acknowledge all conditions of this alarm. Requires a cleared-to-set transition while the alarm conditions are unacknowledged. The alarm instruction clears this parameter.

Default is cleared.

High High program acknowledge. Set by the user program to acknowledge a High High condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged.

Default is cleared.

High High operator acknowledge. Set by the operator interface to acknowledge a High High condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged.


Default is cleared.

High program acknowledge. Set by the user program to acknowledge a High condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged.

Default is cleared.

High operator acknowledge. Set by the operator interface to acknowledge a High condition.

Requires a cleared-to-set transition while the alarm condition is Unacknowledged. The alarm instruction clears this parameter.

Default is cleared.

Low program acknowledge. Set by the user program to acknowledge a Low condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged.

Default is cleared.

Low operator acknowledge. Set by the operator interface to acknowledge a Low condition.

Requires a cleared-to-set transition while the alarm condition is unacknowledged. The alarm instruction clears this parameter.

Default is cleared.



45


Input Parameter

LLProgAck

Data Type

BOOL

LLOperAck

ROCPosProgAck

ROCPosOperAck

ROCNegProgAck

ROCNegOperAck

ProgSuppress

OperSuppress

ProgUnsuppress

OperUnsuppress

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

Description

Low Low program acknowledge. Set by the user program to acknowledge a Low Low condition.

Requires a cleared-to-set transition while the alarm condition is unacknowledged.

Default is cleared.

Low Low operator acknowledge. Set by the operator interface to acknowledge a Low Low condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged.


Default is cleared.

Positive rate of change program acknowledge. Set by the user program to acknowledge a positive rate-of-change condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged.

Default is cleared.

Positive rate of change operator acknowledge. Set by the operator interface to acknowledge a positive rate-of-change condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged. The alarm instruction clears this parameter.

Default is cleared.

Negative rate of change program acknowledge. Set by the user program to acknowledge a negative rate-of-change condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged.

Default is cleared.

Negative rate of change operator acknowledge. Set by the operator interface to acknowledge a negative rate-of-change condition. Requires a cleared-to-set transition while the alarm condition is unacknowledged. The alarm instruction clears this parameter.

Default is cleared.

Set by the user program to suppress the alarm.

Default is cleared.

Set by the operator interface to suppress the alarm. The alarm instruction clears this parameter.

Default is cleared.

Set by the user program to unsuppress the alarm. Takes precedence over Suppress commands.

Default is cleared.

Set by the operator interface to unsuppress the alarm. Takes precedence over Suppress commands. The alarm instruction clears this parameter.

Default is cleared.

46




Input Parameter

ProgDisable

Data Type

BOOL

OperDisable

ProgEnable

OperEnable

AlarmCountReset

HHLimit

HHSeverity

HLimit

BOOL

BOOL

BOOL

BOOL

REAL

DINT

REAL

Description

Set by the user program to disable the alarm.

Default is cleared.

Relay Ladder:




Set by the operator interface to disable the alarm. The alarm instruction clears this parameter.

Default is cleared.

Set by the user program to enable the alarm. Takes precedence over a Disable command.

Default is cleared.

Relay Ladder:




Set by the operator interface to enable the alarm. Takes precedence over Disable command.


Default is cleared.

Set by the user program to reset the alarm counts for all conditions. A cleared-to-set transition resets the alarm counts to zero.

Default is cleared.

High High alarm limit.

Valid = HLimit < HHLimit < maximum positive float.

Default = 0.0.

Severity of the High High alarm condition. This does not affect processing of alarms by the controller, but can be used for sorting and filtering functions at the alarm subscriber.


Default = 500.

High alarm limit.

Valid = LLimit < HLimit < HHLimit.

Default = 0.0.



47


Input Parameter

HSeverity

Data Type

DINT

LLimit

LSeverity

LLLimit

LLSeverity

MinDurationPRE

REAL

DINT

REAL

DINT

DINT

Description

Severity of the High alarm condition. This does not affect processing of alarms by the controller, but can be used for sorting and filtering functions at the alarm subscriber.


Default = 500.

Low alarm limit.

Valid = LLLimit < LLimit < HLimit.

Default = 0.0.

Severity of the Low alarm condition. This does not affect processing of alarms by the controller, but can be used for sorting and filtering functions at the alarm subscriber.


Default = 500.

Low Low alarm limit.

Valid = maximum negative float < LLLimit < LLimit.

Default = 0.0.

Severity of the Low Low alarm condition. This does not affect processing of alarms by the controller, but can be used for sorting and filtering functions at the alarm subscriber.


Default = 500.

Minimum duration preset (milliseconds) for an alarm level condition to remain true before the condition is marked as InAlarm and alarm notification is sent to clients. The controller collects alarm data as soon as the alarm condition is detected, so no data is lost while waiting to meet the minimum duration. Does not apply to rate-of-change conditions.

MinDurationPRE only applies to the first excursion from normal in either direction. For example, once the High condition times out, the High High condition will become active immediately, while a low condition will wait for the timeout period.

Valid = 0...2,147,483,647.

Default = 0.

48




Input Parameter

Deadband

Data Type

REAL

ROCPosLimit

ROCPosSeverity

ROCNegLimit

ROCNegSeverity

ROCPeriod

REAL

DINT

REAL

DINT

REAL

Description

Deadband for detecting that High High, High, Low, and Low Low alarm levels have returned to normal.

A non-zero Deadband can reduce alarm condition chattering if the In value is continually changing but remaining near the level condition threshold. The Deadband value does not affect the transition to the InAlarm (active) state. Once a level condition is active, but before the condition will return to the inactive (normal) state, the In value must either:

• drop below the threshold minus the deadband (for High and High High conditions).

or

• rise above the threshold plus the deadband (for Low and Low Low conditions).

The Deadband is not used to condition the Minimum Duration time measurement.

Valid = 0

≤

Default = 0.0.

Limit for an increasing rate-of-change in units per second. Detection is enabled for any value > 0.0 if ROCPeriod is also > 0.0.

Valid = 0.0...maximum possible float.

Default = 0.0.

Severity of the increasing rate-of-change condition. This does not affect processing of alarms by the controller, but can be used for sorting and filtering functions at the alarm subscriber.


Default = 500.

Limit for a decreasing rate-of-change in units per second. Detection is enabled for any value > 0.0 if ROCPeriod is also > 0.0.


Default = 0.0.

Severity of the decreasing rate-of-change condition. This does not affect processing of alarms by the controller, but can be used for sorting and filtering functions at the alarm subscriber.


Default = 500.

Time period in seconds for calculation (sampling interval) of the rate of change value. Each time the sampling interval expires, a new sample of In is stored, and ROC is recalculated.

Rate-of-change detection is enabled for any value > 0.0.


Default = 0.0.



49



EnableOut

InAlarm

AnyInAlarmUnack

HHInAlarm

HInAlarm

LInAlarm

LLInAlarm

ROCPosInAlarm

ROCNegInAlarm

ROC

HHAcked

HAcked

LAcked

LLAcked

ROCPosAcked

ROCNegAcked

HHInAlarmUnack

HInAlarmUnack

50

Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

REAL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

Description

Enable output.

Alarm active status. Set when any alarm condition is active. Cleared when all alarm conditions are not active (normal status).

Combined alarm active and acknowledged status. Set when any alarm condition is detected and unacknowledged. Cleared when all alarm conditions are normal (inactive), acknowledged, or both.

High High alarm condition status. Set when a High High condition exists. Cleared when no

High High condition exists.

High alarm condition status. Set when a High condition exists. Cleared when no High condition exists.

Low alarm condition status. Set when a Low condition exists. Cleared when no Low condition exists.

Low Low alarm condition status. Set when a Low Low condition exists. Cleared when no

Low Low condition exists.

Positive rate-of-change alarm condition status. Set when a positive rate-of-change condition exists. Cleared when no positive rate-of-change condition exists.

Negative rate-of-change alarm condition status. Set when a negative rate-of-change condition exists. Cleared when no negative rate-of-change condition exists.

Calculated rate-of-change of the In value. This value is updated when the instruction is scanned following each elapsed ROCPeriod. The ROC value is used to evaluate the

ROCPosInAlarm and ROCNegInAlarm conditions.

ROC = (current sample of In – previous sample of In) / ROCPeriod

High High condition acknowledged status. Set when a High High condition is acknowledged. Always set when AckRequired is cleared. Cleared when a High High condition is not acknowledged.

High condition acknowledged status. Set when a High condition is acknowledged. Always set when AckRequired is cleared. Cleared when a High condition is not acknowledged.

Low condition acknowledged status. Set when a Low condition is acknowledged. Always set when AckRequired is cleared. Cleared when a Low condition is not acknowledged.

Low Low condition acknowledged status. Set when a Low Low condition is acknowledged.

Always set when AckRequired is cleared. Cleared when a Low Low condition is not acknowledged.

Positive rate-of-change condition acknowledged status. Set when a positive rate-of-change condition is acknowledged. Always set when AckRequired is cleared. Cleared when a positive rate-of-change condition is not acknowledged.

Negative rate-of-change condition acknowledged status. Set when a negative rate-of-change condition is acknowledged. Always set when AckRequired is cleared.

Cleared when a negative rate-of-change condition is not acknowledged.

Combined High High condition active and unacknowledged status. Set when the High High condition is active (HHInAlarm is set) and unacknowledged. Cleared when the High High condition is normal (inactive), acknowledged, or both.

Combined High condition active and unacknowledged status. Set when the High condition is active (HInAlarm is set) and unacknowledged. Cleared when the High condition is normal

(inactive), acknowledged, or both.





LInAlarmUnack

LLInAlarmUnack

ROCPosInAlarmUnack

ROCNegInAlarmUnack

Suppressed

Disabled

MinDurationACC

HHInAlarmTime

HHAlarmCount

HInAlarmTime

HAlarmCount

LInAlarmTime

LAlarmCount

LLInAlarmTime

LLAlarmCount

ROCPosInAlarmTime

ROCPosInAlarmCount

ROCNegInAlarmTime

ROCNegAlarmCount

Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

LINT

DINT

LINT

DINT

LINT

DINT

LINT

DINT

LINT

DINT

LINT

DINT

Description

Combined Low condition active and unacknowledged status. Set when the Low condition is active (LInAlarm is set) and unacknowledged. Cleared when the Low condition is normal

(inactive), acknowledged, or both.

Combined Low Low condition active and unacknowledged status. Set when the Low Low condition is active (LLInAlarm is set) and unacknowledged. Cleared when the Low Low condition is normal (inactive), acknowledged, or both.

Combined positive rate-of-change condition active and unacknowledged status. Set when the positive rate-of-change condition is active (ROCPosInAlarm is set) and unacknowledged. Cleared when the positive rate-of-change condition is normal (inactive), acknowledged, or both.

Combined negative rate-of-change condition active and unacknowledged status. Set when the negative rate-of-change condition is active (ROCNegInAlarm is set) and unacknowledged. Cleared when the negative rate-of-change condition is normal (inactive), acknowledged, or both.

Suppressed status of the alarm. Set when the alarm is suppressed. Cleared when the alarm is not suppressed.

Disabled status of the alarm. Set when the alarm is disabled. Cleared when the alarm is enabled.

Elapsed time since an alarm condition was detected. When this value reaches

MinDurationPRE, all detected alarm level conditions become active (xInAlarm is set), and a notification is sent to clients.

Timestamp when the ALMA instruction detected that the In value exceeded the High High condition limit for the most recent transition to the active state.

The number of times the High High condition has been activated. If the maximum value is reached, the counter leaves the value at the maximum count value.

Timestamp when the ALMA instruction detected that the In value exceeded the High condition limit for the most recent transition to the active state.

The number of times the High condition has been activated. If the maximum value is reached, the counter leaves the value at the maximum count value.

Timestamp when the ALMA instruction detected that the In value exceeded the Low condition limit for the most recent transition to the active state.

The number of times the Low condition has been activated. If the maximum value is reached, the counter leaves the value at the maximum count value.

Timestamp when the ALMA instruction detected that the In value exceeded the Low Low condition limit for the most recent transition to the active state.

The number of times the Low Low condition has been activated. If the maximum value is reached, the counter leaves the value at the maximum count value.

Timestamp when the ALMA instruction detected that the In value exceeded the positive rate-of-change condition limit for the most recent transition to the active state.

The number of times the positive rate-of-change condition has been activated. If the maximum value is reached, the counter leaves the value at the maximum count value.

Timestamp when the ALMA instruction detected that the In value exceeded the negative rate-of-change condition limit for the most recent transition to the active state.

The number of times the negative rate-of-change condition has been activated. If the maximum value is reached, the counter leaves the value at the maximum count value.



51



AckTime

Data Type

LINT

RetToNormalTime LINT

AlarmCountResetTime LINT

DeliveryER BOOL

DeliveryDN BOOL

DeliveryEN

NoSubscriber

NoConnection

CommError

AlarmBuffered

Subscribers

SubscNotified

Status

InstructFault (Status.0)

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

DINT

BOOL

Description

Timestamp of most recent condition acknowledgement. If the alarm does not require acknowledgement, this timestamp is equal to most recent condition alarm time.

Timestamp of alarm returning to a normal state.

Timestamp indicating when the alarm count was reset.

Delivery error of the alarm notification message. Set when there is a delivery error: either no alarm subscriber was subscribed or at least one subscriber did not receive the latest alarm change state message. Cleared when delivery is successful or is in progress.

Delivery completion of the alarm notification message. Set when delivery is successful: at least one subscriber was subscribed and all subscribers received the latest alarm change state message successfully. Cleared when delivery does not complete successfully or is in progress.

Delivery status of the alarm notification message. Set when delivery is in progress. Cleared when delivery is not in progress.

Alarm had no subscribers when attempting to deliver the most recent message. Set when there are no subscribers. Cleared when there is at least one subscriber.

Alarm’s subscribers were not connected when attempting to deliver the most recent message. Set when all subscribers are disconnected. Cleared when at least one subscriber is connected or there are no subscribers.

Communication error when delivering an alarm message. Set when there are communication errors and all retries are used. This means that a subscriber was subscribed and it had a connection, but the controller did not receive confirmation of message delivery.

Cleared when all connected subscribers confirm receipt of the alarm message.

Alarm message buffered due to a communication error (CommError is set) or a lost connection (NoConnection is set). Set when the alarm message is buffered for at least one subscriber. Cleared when the alarm message is not buffered.

Number of subscribers for this alarm.

Number of subscribers successfully notified about the most recent alarm state change.

Combined status indicators:

Status.0 = InstructFault.

Status.1 = InFaulted.

Status.2 = SeverityInv.

Status.3 = AlarmLimitsInv.

Status.4 = DeadbandInv.

Status.5 = ROCPosLimitInv.

Status.6 = ROCNegLimitInv.

Status.7 = ROCPeriodInv.

Instruction error conditions exist. This is not a minor or major controller error. Check the remaining status bits to determine what occurred.

52





InFaulted (Status.1)

SeverityInv (Status.2)

Data Type

BOOL

BOOL

AlarmLimitsInv

(Status.3)

BOOL

DeadbandInv (Status.4) BOOL

ROCPosLimitInv

(Status.5)

ROCNegLimitInv

(Status.6)

BOOL

BOOL

ROCPeriodInv (Status.7) BOOL

Description

User program has set InFault to indicate bad quality input data. Alarm continues to evaluate

In for alarm conditions.

Alarm severity configuration is invalid.

If severity <1, the instruction uses Severity = 1.

If severity >1000, the instruction uses Severity = 1000.

Alarm Limit configuration is invalid (for example, LLimit < LLLimit). If invalid, the instruction clears all level conditions active bits. Until the fault is cleared, no new level conditions can be detected.

Deadband configuration is invalid. If invalid, the instruction uses Deadband = 0.0.

Valid = 0

≤

Positive rate-of-change limit invalid. If invalid, the instruction uses ROCPosLimit = 0.0, which disables positive rate-of-change detection.

Negative rate-of-change limit invalid. If invalid, the instruction uses ROCNegLimit = 0.0, which disables negative rate-of-change detection.

Rate-of-change period invalid. If invalid, the instruction uses ROCPeriod = 0.0, which disables rate-of-change detection.

Description

The ALMA instruction detects alarms based on the level or rate of change of a value.

The ALMA instruction provides additional functionality when used with

RSLinx Enterprise and FactoryTalk View SE software. You can display alarms in the Alarm Summary, Alarm Banner, Alarm Status Explorer, and Alarm Log

Viewer displays in FactoryTalk View SE software.

RSLinx Enterprise software subscribes to alarms in the controller. Use the output parameters to monitor the instruction to see the alarm subscription status and to display alarm status changes. If a connection to RSLinx

Enterprise software is lost, the controller can briefly buffer alarm data until the connection is restored.



53


State Diagrams when Acknowledgement Required

In >= HLimit, MinDurationACC >= MinDurationPRE

HInAlarm = False

HAcked = True

Ack

1

HInAlarm = False

HAcked = False

In <

(HL imit

In

>=

- De adb and

)

In

< (

HL imi t, M inD ura tion

AC

C >

- D ea db an d)

Hli mit

= M inD ura tion

PR

E

HInAlarm = True

HAcked = False

Ack

1

HInAlarm = True

HAcked = True

1

H alarm condition can be acked by several different ways: HProgAck, HOperAck, ProgAckAll, OperAckAll, clients (RSLogix 5000 software, RSView software).

In >= HHLimit, MinDurationACC >= MinDurationPRE

HHInAlarm = False

HHAcked = True

Ack

1

HHInAlarm = False

HHAcked = False

In <

(HH

Lim it - D ead ban

In

>=

HH

Lim it, M inD

In d) ura tion

AC

C >

= M

De ad ba nd

)

< (

HH

Lim it inD ura tion

PR

E

HHInAlarm = True

HHAcked = False

Ack

1

HHInAlarm = True

HHAcked = True

1

HH alarm condition can be acked by several different ways: HHProgAck, HHOperAck, ProgAckAll, OperAckAll, clients (RSLogix 5000 software, RSView software).

In <= LLimit, MinDurationACC >= MinDurationPRE

LInAlarm = False

LAcked = True

Ack

1

LInAlarm = False

LAcked = False

In >

(LLim

In

<= it +

Dea dban d)

De ad ba nd

)

In

> (

Llim it + ura tion

AC

C >

= M inD ura tion

PR

E

LL imi t, M inD

LInAlarm = True

LAcked = False

Ack

1

LInAlarm = True

LAcked = True

1

L alarm condition can be acked by several different ways: LProgAck, LOperAck, ProgAckAll, OperAckAll, clients (RSLogix 5000 software, RSView software).

In <= LLLimit, MinDurationACC >= MinDurationPRE

LLInAlarm = False

LLAcked = True

Ack

1

LLInAlarm = False

LLAcked = False

In >

(LLL

In imit

<=

+ D ead band

)

In

> (

LL

Lim it, M inD ura tion

AC

De ad ba nd

)

LL

Lim it +

C >

= M inD ura tion

PR

E

LLInAlarm = True

LLAcked = False

Ack

1

LLInAlarm = True

LLAcked = True

1

LL alarm condition can be acked by several different ways: LLProgAck, LLOperAck, ProgAckAll, OperAckAll, clients (RSLogix 5000 software, RSView software).

ROC =

In(Current Sample) In(Previou sSample)

ROCPeriod

Where a new sample is collected on the next scan after the ROCPeriod has elapsed.

ROC >= RocPosLimit

RocPosInAlarm = False

RocPosAcked = True

Ack

1


RocPosAcked = False

RO

C <

Roc

Pos

Lim it

RO

C >

= R ocP osL imi t

RO

C <

Ro cP osL imi t

RocPosInAlarm = True

RocPosAcked = False

Ack

1


RocPosAcked = True

1 ROCPos alarm condition can be acked by several different ways: RocPosProgAck, RocPosOperAck, ProgAckAll,

OperAckAll, clients (RSLogix 5000 software, RSView software).

l,

ROC <= -RocNegLimit

RocNegInAlarm = False

RocNegAcked = True

Ack

1


RocNegAcked = False

RO

C >

-Ro cNe gLim it

RO

C <

= -

Ro cN eg

Lim it

RO

C >

-Ro cN eg

Lim it

RocNegInAlarm = True

RocNegAcked = False

Ack

1


RocNegAcked = True

1 ROCNeg alarm condition can be acked by several different ways: RocNegProgAck, RocNegOperAck, ProgAckAll,

,

OperAckAll, clients (RSLogix 5000 software, RSView software).

54




State Diagrams when Acknowledgement Not Required

In >= HLimit, MinDurationACC >= MinDurationPRE

HInAlarm = False HInAlarm = True HAcked = True

In < (HLimit - Deadband)

In <= LLimit, MinDurationACC >= MinDurationPRE

LInAlarm = False LInAlarm = True LAcked = True

In > (LLimit + Deadband)

HHInAlarm = False

In >= HHLimit, MinDurationACC >= MinDurationPRE

In < (HHLimit - Deadband)

HHInAlarm = True

LLInAlarm = False

In <= LLLimit, MinDurationACC >= MinDurationPRE

In > (LLLimit + Deadband)

LLInAlarm = True

HHAcked = True

LLAcked = True

ROC =

In(Current Sample) In(Previou sSample)

ROCPeriod

ROC >= ROCPosLimit


ROC < ROCPosLimit

ROC <= -ROCNegLimit


ROC > -ROCNegLimit

Where a new sample is collected on the next scan after the ROCPeriod has elapsed.



RocPosAcked = True

RocNegAcked = True


Arithmetic status flags are set for the ROC output.


Minor Fault

ROC overflow

Fault Type

4

Execution:

Fault Code

4

Condition

prescan rung-condition-in is false



All the xInAlarm parameters are cleared and all alarm conditions are acknowledged.






55


Condition

rung-condition-in is true postscan



EnableOut is set.


56




Condition


EnableIn is cleared







No action taken.

No action taken.



No action taken.

No action taken.




EnableOut is set.

No action taken.




No action taken.



57


ALMA Level Condition Acknowledge Required

58




ALMA Level Condition Acknowledge Not Required



59


ALMA Rate of Change Acknowledge Required

60




ALMA Rate of Change Acknowledge Not Required

Example:

A tank alarm is activated if the tank level surpasses a High or High High limit.

Programmatically acknowledge all the alarm conditions with a cleared-to-set



61

Chapter 1 FactoryTalk Alarms and Events Logix-based Instructions (ALMD, ALMA) transition of the Tank32LevelAck tag value. The application logic must clear

Tank32LevelAck.

Relay Ladder

Structured Text

ALMA(Tank32Level,Tank32LT,Tank32LevelAck,0, 0);

Function Block

62



Configure an Alarm

Instruction


After you enter an ALMD or ALMA instruction and specify the alarm tag name, use the Alarm Configuration dialog to specify the details of the message.

Click here to configure the instruction.

The Properties dialog for the alarm instruction includes a Configuration tab.

Option

Condition - ALMD instruction

Input Level - ALMA instruction

Input Rate of Change - ALMA instruction

For each alarm instruction, configure this information.

Description

Condition to trigger the alarm.

Select Input=1 for an active alarm when In=1. Select Input=0 for an active alarm when In=0.

Input Level (High High, High, Low, or Low Low) or Input Rate of Change (Positive or

Negative) to trigger an alarm.

Select the alarm conditions and enter the limits for those conditions. Disable rate-of-change conditions by entering a 0 for the period or limit.



63


Option

Severity

Minimum Duration

Latched - ALMD instruction

Deadband - ALMA instruction

Acknowledgement Required

Description

Select a severity range from 1...1000 to rank the importance of an alarm condition. A severity of 1 is for low priority alarms; a severity of 1000 is for an emergency condition.

By default, in the FactoryTalk Alarms and Events system, severity ranges are mapped to priorities as follows:

•

1...250 are low priority.

•

251...500 are medium priority.

•

501...750 are high priority.

•

751...1000 are urgent priority.

You can configure the severity-to-priority mapping in the FactoryTalk Alarms and Events system. See the FactoryTalk help for details.

Enter the amount of time in ms an alarm condition must be active before reporting the alarm.

Select Latched if you want the alarm to stay active (InAlarm) after the alarm condition returns to inactive (normal). Latched alarms require a reset command to transition to normal. The reset command must be received after the condition returns to normal.

Acknowledge commands will not reset a latched alarm.

Specify a Deadband value to reduce alarm condition chattering caused by small fluctuations in the In value.

The deadband value does not affect the alarm limit for the transition into the active state, and is also not used during the Minimum Duration interval.

Once a level condition becomes active (InAlarm), it will remain active until the In value crosses back over the limit by the specified deadband. For example, if the High limit is 80, the Low limit is 20, and the Deadband is 5, the High condition will be active at

≥

80 and return to normal at

≤ ≤

20 and return to normal at

≥ ≤

25.

The Deadband has no effect on Rate of Change alarm conditions.

Alarms are configured to require acknowledgement by default. Acknowledgement indicates that an operator is aware of the alarm condition, whether or not conditions have returned to normal.

Clear the Acknowledgement Required setting when you want the alarm to appear and disappear from the Alarm Summary on the HMI with no operator interaction.

Alarms that do not require acknowledgement always have the Acked status set.

If a digital alarm is configured as latched, the reset command also acknowledges the alarm.

64




Option

Alarm class

View command

Description

Use the alarm class to group related alarms. Specify the alarm class exactly the same for each alarm you want in the same class. The alarm class is case sensitive.

For example, specify class Tank Farm A to group all the tank alarms for a specific area. Or specify class Control Loop to group all alarms for PID loops.

You can then display and filter alarms at the HMI based on the class. For example, an operator can display all tank alarms or all PID loop alarms.

The alarm class does not limit the alarms that an Alarm Summary object subscribes to. Use the alarm class to filter the alarms that display to an operator once they have been received by the Alarm Summary object. FactoryTalk View software can filter the alarm class substituting wild cards for characters.

Execute a command on the operator station when requested by an operator for a specific alarm. This lets an operator execute any standard FactoryTalk View command, such as call specific faceplates and displays, execute macros, access help files, and launch external applications. When the alarm condition occurs and is displayed to the operator, a button on the summary and banner displays lets the operator run an associated view command.

Be careful to enter the correct command syntax and test the command at runtime as there is no error checking performed when the command is entered.

You can edit all aspects of the alarm configuration offline and online. Online edits of new and existing alarms are immediately sent to FactoryTalk subscribers (legacy HMI terminals that are just polling the tags do not automatically update). FactoryTalk subscribers do not have to re-subscribe to receive updated information. Online changes automatically propagate from the controller alarm structure to the rest of the architecture.

Enter Alarm Message Text

Enter appropriate message text to display when an alarm condition is active

(InAlarm). For an ALMD instruction, you enter the message information on



65

Chapter 1 FactoryTalk Alarms and Events Logix-based Instructions (ALMD, ALMA) the Configuration tab. For an ALMA instruction, you enter the message information on the Message tab.

Option

Message string

Associated tags

66

To define an alarm message, specify this information.

Description

The message string contains the information to display to the operator regarding the alarm.

In addition to entering text, you can also embed variable information. In the alarm message editor, select the variable you want and add it anywhere in the message string.

The message string can have a maximum of 255 characters, including the characters that specify any embedded variables (not the number of characters in the actual values of the embedded variables). For example, /*S:0 %Tag1*/ specifies a string tag and adds 13 characters towards the total string length, but the actual value of the string tag could contain 82 characters.

You cannot programmatically access the alarm message string from the alarm tag. To change the alarm message based on specific events, configure one of the associated tags as a string data type and embed that associated tag in the message.

You can have multiple language versions of messages. You enter the different language via the import/export utility. For more information, see page 68 .

You can select as many as four additional tags from the controller project to associate with the alarm. The values of these tags are sent with an alarm message to the alarm server. For example, a digital alarm for a pressure relief valve might also include information such as pump speed and tank temperature.

Associated tags may be any atomic data type (BOOL, DINT, INT, SINT, or REAL) or a STRING.

They may be elements in a UDT or an Array. Variable array references are not allowed. If the alarm is controller-scoped, the associated tags must also be controller-scoped.

Optionally, embed the associated tags into the message text string.

Associated tag values are always sent with the alarm, viewable by the operator, and entered in the history log, regardless of whether you embed them in the message string.




Message String Variables

Variable

Alarm name

Condition name

Input value

Limit value

Severity

You can embed this variable information in a message string.

Embeds in the Message String Default Code Added to Message String

/*S:0 %AlarmName*/

The name of the alarm, which consists of the controller name, program name, and tag name. For example,

[Zone1Controller]Program:Main.MyAlarmTagName.

/*S:0 %ConditionName*/

The condition that triggers the alarm:

• digital alarm displays the trip.

• analog alarm displays HiHi, Hi, Lo, LoLo,

ROC_POS, or ROC_NEG.

The input value to the alarm:

• digital alarm displays 0 or 1.

• analog alarm displays the value of the input variable being monitored by the alarm.

/*N:5 %InputValue NOFILL DP:0*/

/*N:5 %LimitValue NOFILL DP:0*/

The threshold of the alarm:

• digital alarm displays 0 or 1.

• analog alarm displays the actual configured range check for the analog alarm condition.

The configured severity of the alarm condition.

Values of associated tags The value of a tag configured to be included with the alarm event.

/*N:5 %Severity NOFILL DP:0*/

/*N:5 %Tag1 NOFILL DP:0*/

The code varies depending on the type of tag you select, how many digits or characters are in a tag value, and whether you want to left fill the empty bits with spaces or zeroes. For example:

Tag

BOOL value

DINT value, 9 digits, space left fill

REAL input value, 9 digits (includes decimal), 3 digits after decimal, zero left fill

REAL value, 8 digits (includes decimal), 4 digits after decimal, zero left fill

String value, no fixed width

String value, 26 characters, fixed width

Code

/*N:1 %Tag1 NOFILL DP:0*/

/*N:9 %Tag2 SPACEFILL DP:0*/

/*N:9 %InputValue NOFILL DP:3*/

/*N:8 %Tag3 ZEROFILL DP:4*/

/*S:0 %Tag4*/

/*S:26 %Tag4*/

All of this variable information is included with the alarm data, viewable by the operator, and entered in the history log, regardless of whether you embed the information in the message text.



67


Multiple Language Versions of Alarm Messages

You can maintain alarm messages in multiple languages. Either enter the different languages in the associated language versions of RSLogix 5000 programming software or in an import/export (.CSV or .TXT) file.

You can access alarm message text from an import/export (.CSV or .TXT) file and add additional lines for translated versions of the original message string.

Messages in different languages use ISO language codes in the TYPE column.

Alarm message text, including embedded variable codes, for the operator is in the DESCRIPTION column. The SPECIFIER identifies the alarm condition.

Use the import/export utility to create and translate message strings into multiple languages. The .TXT import/export format supports double-byte characters, so you can use this format for all languages, including Chinese,

Japanese, and Korean. The .CSV import/export format does not support double-byte characters.

Importing and exporting messages always performs a merge. Deleting a message in a .CSV or .TXT file does not delete the message from the .ACD file. To delete a message, import the .CSV or .TXT file with the type, name, and specifier fields filled in but the description blank.

68



Monitor Alarm Status


On the Status tab of the alarm dialog, monitor the alarm condition, acknowledge an alarm, disable an alarm, suppress an alarm, or reset an alarm.

Use the dialog selections to see how an alarm behaves, without needing an operational HMI.

Buffering Alarms

In order to receive controller-based alarm messages, alarm clients (such as an

RSLinx Enterprise server) must establish a subscription to the alarms in the

Logix controller. The controller maintains a connection to each subscriber and monitors the status of that connection.

As alarm state changes occur, the alarm instructions in the controller cache the necessary information (such as timestamps and associated tag values) and request the transmission of the alarm message to all of the subscribers. The publisher mechanism delivers the alarm messages to each subscriber as quickly as possible.

If any subscriber fails to confirm receipt of the alarm message, or if the connection to a known subscriber is not good, the publisher mechanism stores the undelivered alarm messages in a 100 KB buffer. Each subscriber has its own buffer so communication problems with one subscriber do not interfere with alarm delivery to other subscribers. When the buffer is full, newer alarm messages are discarded. The buffer is created when the subscriber establishes its initial connection and is maintained for a configurable length of time

(0...120 minutes, default is 20 minutes) after a subscriber loses its connection.

When the subscriber re-establishes a connection within the buffer timeout interval, it obtains the current state of all alarms, begins to receive current alarm messages, and also uploads any buffered messages that may have accumulated. Even if the buffer was full, and messages were discarded, the



69

Chapter 1 FactoryTalk Alarms and Events Logix-based Instructions (ALMD, ALMA) subscribers accurately synchronize to the current state of the alarms (including the most recent InAlarmTime, RetToNormalTime, and AckTime timestamps).

The buffer continues until is filled. Once filled, the buffer stops adding alarm transitions until space is made available in the buffer by the subscriber.

Programmatically Access

Alarm Information

Each alarm instruction has an alarm structure that stores alarm configuration and execution information. The alarm structure includes both Program and

Operator control elements and operator elements. The alarm instructions do not use mode settings to determine whether program access or operator access is active, so these elements are always active.

There are three ways to perform actions on an alarm instruction.

Access

User program

Custom HMI

Standard HMI object

Alarm Structure Elements

•

ProgAck

•

ProgReset

•

ProgSuppress

•

ProgDisable

•

ProgEnable

•

OperAck

•

OperReset

•

OperSuppress

•

OperDisable

•

OperEnable

Not accessible

Considerations

Use controller logic to programmatically access elements of the alarming system. For example, the control program can determine whether to disable a series of alarms that are related to a single root cause. For example, the control program could disable an alarm instruction, MyDigitalAlarm of data type ALARM_DIGITAL, by accessing the tag member MyDigitalAlarm.ProgDisable.

Create a custom HMI faceplate to access elements of the alarming system. For example, if the operator needs to remove a tool, rather than manually disable or suppress alarms individually from the alarming screens, the operator can press a disable key that accesses a tag MyDigitalAlarm.OperDisable.

Operator parameters work with any Rockwell Automation or third-party operator interface to allow control of alarm states.

When an operator parameter is set, the instruction evaluates whether it can respond to the request, then always resets the parameter.

Normal operator interaction is through the alarm summary, alarm banner, and alarm status explorer objects in the FactoryTalk View application. This interaction is similar to the custom HMI option described above, but there is no programmatic visibility or interaction.

When you create an alarm instruction, you must create and assign a tag of the correct alarm data type for that alarm. For example, create MyDigitalAlarm of data type ALARM_DIGITAL. In relay ladder, these instruction parameters must be entered on the instruction:

•

ProgAck

•

ProgReset

•

ProgDisable

•

ProgEnable

70




In relay ladder and structured text, the value or tag you assign to an instruction parameter (such as ProgAck) is automatically written to the alarm tag member

(such as MyAnalogAlarm.ProgAck) each time the instruction is scanned.

In relay ladder and structured text, if you want to programmatically access the alarm structure, assign the structure tag to the parameter on the instruction.

For example, to use MyAnalogAlarm.ProgAck in logic, assign the tag

MyAnalogAlarm.ProgAck to the ProgAck parameter.

Suppress or Disable Alarms

Suppress alarms to remove alarms you know exist from the HMI but still keep the alarms alive. This lets you clear the alarm summary while you are resolving a known alarm without continuing to view alarm information. A suppressed alarm does not appear on the operator summary or banner screens, but a suppressed alarm is still sent to subscribers, logged in the historical database, able to transition alarm status, time stamped, and responsive to other programmatic or operator interactions.

•

When an alarm is Suppressed, it continues to function normally, monitor the In parameter for alarm conditions, and respond to

Acknowledge requests. All subscribers are notified of this event, and any alarm messages generated while the alarm is in the Suppressed state include the Suppressed status. Alarm clients can respond differently to

Suppressed alarms. For example, suppressed alarms can be logged to the historical database but not annunciated to the operator.

•

When an alarm is Unsuppressed, all subscribers are notified and alarm messages to subscribers no longer include the Suppressed status.

Disable an alarm to treat the alarm as if it does not exist in the control program. A disabled alarm does not transition alarm status or get logged in the historical database. A disabled alarm is still tracked, and can be re-enabled, in the Alarm Status Explorer in FactoryTalk View SE software.

•

When an alarm is Disabled, all of its conditions are set to the initial state

(InAlarm is cleared and Acked is set). The In parameter is not monitored for alarm conditions. All subscribers are notified of this event.

•

When an alarm is Enabled, it begins to monitor the In parameter for alarm conditions. All subscribers are notified of this event.



71


Controller-based Alarm

Execution

Source

Alarm tag members

Client messages

Controller-based alarms process inputs from two sources.

Description

Alarm tag members are, for the most part, processed when the user application scans the alarm instruction. This includes:

• processing changes to configuration parameters.

• evaluating the alarm condition.

• measuring elapsed time for MinDuration.

• capturing InAlarmTime and RetToNormalTime timestamps.

• capturing associated tag values.

• processing Prog and Oper commands.

In addition, these alarm tag status members are updated as alarm messages are delivered to each subscriber, asynchronously to the program scan:

•

DeliveryEN, DeliveryER, DeliveryDN

•

NoSubscriber, NoConnection, CommError, AlarmBuffered, SubscNotified

Client messages are processed as they are received, asynchronously to the program scan.

•

Reset, Acknowledge, Disable/Enable, and Suppress/Unsuppress commands from an

RSLogix 5000 terminal

•

Reset, Acknowledge, Disable/Enable, and Suppress/Unsuppress commands from a

FactoryTalk View SE alarm subscriber

Use care when determining where to place alarm instructions in the application. The accuracy of the timestamps are affected by how quickly the instruction is scanned after the alarm condition changes state. MinDuration time accumulation and Rate of Change calculations require repeated scanning, within time intervals determined by the user application. Alarm instructions must continue to be scanned after the alarm condition becomes false, so that the ReturnToNormal transition may be detected. For example, if you desire

10 ms accuracy on timestamps, you could place the alarm instructions that need that resolution in a 10 ms periodic task.

72




Controller Memory Use

As a guideline use the following alarm sizes for a rough calculation of controller memory usage:

•

Typically 1 KB per digital alarm with no associated tags

Digital Alarm Example

Digital alarm with no associated tags and this configuration:

•

Alarm message: Contactor Fault

•

Alarm Class: Tank Farm A

Digital alarm with two associated tags and this configuration:

•


•


•

Associated Tag 1 = DINT data type

•


Digital alarm with two associated tags and this configuration:

•


•


•


•

Associated Tag 2 = STRING data type

Approximate Size

1012 bytes

1100 bytes

1522 bytes



73


•

Typically 2.2 KB per analog alarm with no associated tags

Analog Alarm Example

Analog alarm with no associated tags and this configuration:

•

HH Alarm message: Level Alarm

•

H Alarm Message: Level Alarm

•

L Alarm Message: Level Alarm

•

LL Alarm Message: Level Alarm

•

Rate of Change Positive Message: Fill Too Fast

•

Rate of Change Negative Message: Empty Too Fast

•


Analog alarm with two associated tags and this configuration:

•


•


•


•


•


•


•


•


•


Analog alarm with two associated tags and this configuration:

•


•


•


•


•


•


•


•


•

Associated Tag 2 = STRING data type

Approximate Size

2228 bytes

2604 bytes

4536 bytes

Longer message strings, as well as message strings for multiple languages, consume additional memory from your controller.

Actual memory usage will depend on how the alarm is configured, message length, and any associated tags passed with the alarm.

74




Scan Time

These execution times show how ALMD instructions and ALMA instructions affect total scan time.

Rung State Execution Times

Digital Alarm (ALMD) Analog Alarm (ALMA)

No Alarm State

Change

Rung False 8

μ s

Rung True 8

μ s

Alarm State Change Rung False 35

μ s

Rung True 35

μ s

17

60

17

μ

μ

μ

126 s s s

μ s

An alarm state change is any event that changes the condition of the alarm, such as acknowledging or suppressing the alarm. Minimize the potential for a large number of alarms changing state simultaneously (alarm bursts) by creating dependencies on related alarms. Large alarm bursts can have a significant impact on application code scan time.



75


Notes:

76



Bit Instructions

(XIC, XIO, OTE, OTL, OTU, ONS, OSR, OSF, OSRI, OSFI)

Chapter

2

Introduction

Use the bit (relay-type) instructions to monitor and control the status of bits.

If You Want To

enable outputs when a bit is set enable outputs when a bit is cleared set a bit set a bit (retentive) clear bit (retentive) enable outputs for one scan each time a rung goes true


XIC

XIO

OTE

OTL

OTU

ONS


relay ladder structured text

(1) relay ladder structured text





(1) relay ladder

See Page

set a bit for one scan each time a rung goes true set a bit for one scan each time the rung goes false set a bit for one scan each time the input bit is set in function block

OSR

OSF relay ladder set a bit for one scan each time the input bit is cleared in function block

OSRI

OSFI structured text function block structured text function block

(1)

There is no equivalent structured text instruction. Use other structured text programming to achieve the same result. See the description for the instruction.

78

80

82

84

86

88

91

94

96

99



77

Chapter 2 Bit Instructions (XIC, XIO, OTE, OTL, OTU, ONS, OSR, OSF, OSRI, OSFI)

Examine If Closed (XIC)

Operands:

The XIC instruction examines the data bit to see if it is set.

Relay Ladder

Operand

data bit

Type

BOOL

Format

tag

Description

bit to be tested

Structured Text

Structured text does not have an XIC instruction, but you can achieve the same results using an IF...THEN construct.

IF data_bit THEN

<statement>;

END_IF;

See Appendix 641B, Function Block Attributes for information on the syntax of constructs within structured text.

Description:

The XIC instruction examines the data bit to see if it is set.


not affected


none

Execution:

Condition

prescan rung-condition-in is false rung-condition-in is true




examine data bit data bit = 0 rung-condition-out is set to false data bit = 1 postscan

78

rung-condition-out is set to true end




Bit Instructions (XIC, XIO, OTE, OTL, OTU, ONS, OSR, OSF, OSRI, OSFI) Chapter 2

Example 1:

If limit_switch_1 is set, this enables the next instruction (the rung-condition-out is true).

Relay Ladder

Structured Text

IF limit_switch THEN

<statement>;

END_IF;

Example 2:

If S:V is set (indicates that an overflow has occurred), this enables the next instruction (the rung-condition-out is true).

Relay Ladder

Structured Text

IF S:V THEN

<statement>;

END_IF;



79


Examine If Open (XIO)

Operands:

The XIO instruction examines the data bit to see if it is cleared.

Relay Ladder

Operand

data bit

Type

BOOL

Format

tag

Description

bit to be tested

Structured Text

Structured text does not have an XIO instruction, but you can achieve the same results using an IF...THEN construct.

IF NOT data_bit THEN

<statement>;

END_IF;

See Appendix 641B, Function Block Attributes for information on the syntax of constructs within structured text.

Description:

The XIO instruction examines the data bit to see if it is cleared.


not affected


none

Execution:

Condition





examine data bit data bit = 0 rung-condition-out is set to true data bit = 1 postscan

80

rung-condition-out is set to false end





Example 1:

If limit_switch_2 is cleared, this enables the next instruction (the rung-condition-out is true).

Relay Ladder

Structured Text

IF NOT limit_switch_2 THEN

<statement>;

END_IF;

Example 2:

If S:V is cleared (indicates that no overflow has occurred), this enables the next instruction (the rung-condition-out is true).

Relay Ladder

Structured Text

IF NOT S:V THEN

<statement>;

END_IF;



81


Output Energize (OTE)

Operands:

The OTE instruction sets or clears the data bit.

Relay Ladder

Operand

data bit

Type

BOOL

Format

tag

Description

bit to be set or cleared

Condition

prescan postscan

Structured Text

Structured text does not have an OTE instruction, but you can achieve the same results using a non-retentive assignment. data_bit [:=] BOOL_expression;

See Appendix 641B, Function Block Attributes for information on the syntax of assignments and expressions within structured text.

Description:

When the OTE instruction is enabled, the controller sets the data bit. When the OTE instruction is disabled, the controller clears the data bit.


not affected


none

Execution:

rung-condition-in is false rung-condition-in is true


The data bit is cleared.




The data bit is set.




82




Example:

When switch is set, the OTE instruction sets (turns on) light_1. When switch is cleared, the OTE instruction clears (turns off) light_1.

Relay Ladder

Structured Text

light_1 [:=] switch;



83


Output Latch (OTL)

The OTL instruction sets (latches) the data bit.

Operands:

Condition


Relay Ladder

Operand

data bit

Type

BOOL

Format

tag

Description

bit to be set

Structured Text

Structured text does not have an OTL instruction, but you can achieve the same results using an IF...THEN construct and an assignment.

IF BOOL_expression THEN data_bit := 1;

END_IF;

See Appendix 641B, Function Block Attributes for information on the syntax of constructs, expressions, and assignments within structured text.

Description:

When enabled, the OTL instruction sets the data bit. The data bit remains set until it is cleared, typically by an OTU instruction. When disabled, the OTL instruction does not change the status of the data bit.


not affected


none

Execution:


The data bit is not modified.




The data bit is set.




84




Example:

When enabled, the OTL instruction sets light_2. This bit remains set until it is cleared, typically by an OTU instruction.

Relay Ladder

Structured Text

IF BOOL_expression THEN light_2 := 1;

END_IF;



85


Output Unlatch (OTU)

Operands:

The OTU instruction clears (unlatches) the data bit.

Relay Ladder

Operand

data bit

Type

BOOL

Format

tag

Description

bit to be cleared

Condition

prescan postscan

Structured Text

Structured text does not have an OTU instruction, but you can achieve the same results using an IF...THEN construct and an assignment.

IF BOOL_expression THEN data_bit := 0;

END_IF;

See Appendix 641B, Function Block Attributes for information on the syntax of constructs, expressions, and assignments within structured text.

Description:

When enabled, the OTU instruction clears the data bit. When disabled, the

OTU instruction does not change the status of the data bit.


not affected


none

Execution:

rung-condition-in is false rung-condition-in is true










86




Example:

When enabled, the OTU instruction clears light_2.

Relay Ladder

Structured Text

IF BOOL_expression THEN light_2 := 0;

END_IF;



87


One Shot (ONS)

The ONS instruction enables or disables the remainder of the rung, depending on the status of the storage bit.

Operands:

Relay Ladder

Operand Type

storage bit BOOL

Format

tag

Description

internal storage bit stores the rung-condition-in from the last time the instruction was executed

Structured Text

Structured text does not have an ONS instruction, but you can achieve the same results using an IF...THEN construct.

IF BOOL_expression AND NOT storage_bit THEN

<statement>;

END_IF; storage_bit := BOOL_expression;

See Appendix 641B, Function Block Attributes for information on the syntax of constructs, expressions, and expressions within structured text.

Description:

When enabled and the storage bit is cleared, the ONS instruction enables the remainder of the rung. When disabled or when the storage bit is set, the ONS instruction disables the remainder of the rung.


not affected


none

88




Condition


Execution:


The storage bit is set to prevent an invalid trigger during the first scan.


The storage bit is cleared.


postscan examine storage bit storage bit = 0 storage bit is set rung-condition-out is storage bit = 1 storage bit remains set rung-condition-out is set end



Example:

You typically precede the ONS instruction with an input instruction because you scan the ONS instruction when it is enabled and when it is disabled for it to operate correctly. Once the ONS instruction is enabled, the rung-condition-in must go clear or the storage bit must be cleared for the

ONS instruction to be enabled again.



89


On any scan for which limit_switch_1 is cleared or storage_1 is set, this rung has no affect. On any scan for which limit_switch_1 is set and storage_1 is cleared, the ONS instruction sets storage_1 and the ADD instruction increments sum by

1. As long as limit_switch_1 stays set, sum stays the same value. The

limit_switch_1 must go from cleared to set again for sum to be incremented again.

Relay Ladder

Structured Text

IF limit_switch_1 AND NOT storage_1 THEN sum := sum + 1;

END_IF; storage_1 := limit_switch_1;

90




One Shot Rising (OSR)

The OSR instruction sets or clears the output bit, depending on the status of the storage bit.

This instruction is available in structured text and function block as OSRI, see page 96 .

Operands:

Relay Ladder

Operand Type

storage bit BOOL

Format

tag

Description

internal storage bit stores the rung-condition-in from the last time the instruction was executed bit to be set output bit BOOL tag

Description:

When enabled and the storage bit is cleared, the OSR instruction sets the output bit. When enabled and the storage bit is set or when disabled, the OSR instruction clears the output bit rung condition in storage bit output bit instruction is executed instruction resets during next scan execution


not affected


none

Execution:



91


Condition



The storage bit is set to prevent an invalid trigger during the first scan.

The output bit is cleared.



The output bit is not modified.


rung-condition-in is true postscan examine storage bit storage bit = 0 storage bit is set output bit is set storage bit = 1 storage bit remains set output bit is cleared end


The output bit is not modified.


92




Example:

Each time limit_switch_1 goes from cleared to set, the OSR instruction sets

output_bit_1 and the ADD instruction increments sum by 5. As long as

limit_switch_1 stays set, sum stays the same value. The limit_switch_1 must go from cleared to set again for sum to be incremented again. You can use

output_bit_1 on multiple rungs to trigger other operations



93


One Shot Falling (OSF)

The OSF instruction sets or clears the output bit depending on the status of the storage bit.

This instruction is available in structured text and function block as OSFI, see page 99 .

Operands:

Relay Ladder Operands

Operand Type

storage bit BOOL

Format

tag

Description

internal storage bit stores the rung-condition-in from the last time the instruction was executed bit to be set output bit BOOL tag

Description:

When disabled and the storage bit is set, the OSF instruction sets the output bit. When disabled and the storage bit is cleared, or when enabled, the OSF instruction clears the output bit.

rung condition in storage bit output bit instruction is executed instruction resets during next scan execution


not affected


none

94




Execution:

Condition

prescan


The storage bit is cleared to prevent an invalid trigger during the first scan.



rung-condition-in is false examine storage bit storage bit = 0 storage bit remains cleared output bit is cleared storage bit = 1 postscan storage bit is cleared output bit is set rung-condition-in is true end

The storage bit is set.



See rung-condition-in is false above.

Example:

Each time limit_switch_1 goes from set to cleared, the OSF instruction sets

output_bit_2 and the ADD instruction increments sum by 5. As long as

limit_switch_1 stays cleared, sum stays the same value. The limit_switch_1 must go from set to cleared again for sum to be incremented again. You can use

output_bit_2 on multiple rungs to trigger other operations.



95


One Shot Rising with Input

(OSRI)

The OSRI instruction sets the output bit for one execution cycle when the input bit toggles from cleared to set.

This instruction is available in relay ladder as OSR, see page 91 .

Operands:

OSRI(OSRI_tag);

Structured Text

Operand Type

OSRI tag FBD_ONESHOT

Format

structure

Description

OSRI structure

Input Parameter

EnableIn

Data Type

BOOL

InputBit BOOL


EnableOut

OutputBit

Data Type

BOOL

BOOL

Function Block

Operand Type

OSRI tag FBD_ONESHOT

Format

structure

Description

OSRI structure

FBD_ONESHOT Structure

Description

Function Block:



Default is set.


No effect. The instruction executes.

Input bit. This is equivalent to rung condition for the relay ladder OSR instruction.

Default is cleared.

Description

The instruction produced a valid result.

Output bit

96




Description:

When InputBit is set and InputBit n-1

is cleared, the OSRI instruction sets

OutputBit. When InputBit n-1 instruction clears OutputBit.

is set or when InputBit is cleared, the OSRI

InputBit

InputBit n-1

OutputBit instruction is executed instruction resets during next scan execution

40048 postscan


not affected


none

Execution:

Condition


EnableIn is cleared

EnableIn is set


No action taken.

InputBit

n-1

is set.

InputBit

n-1

is set.

EnableOut is cleared, the instruction does nothing, and the outputs are not updated.

On a cleared to set transition of InputBit, the instruction sets InputBit n-1

.


EnableOut is set.

No action taken.


No action taken.

InputBit

n-1

is set.

InputBit

n-1

is set.

na

On a cleared to set transition of InputBit, the instruction sets InputBit n-1

.

EnableIn is always set.


No action taken.



97


Example:

When limit_switch1 goes from cleared to set, the OSRI instruction sets

OutputBit for one scan.

Structured Text

OSRI_01.InputBit := limit_switch1;

OSRI(OSRI_01);

State := OSRI_01.OutputBit;

Function Block

98




One Shot Falling with Input

(OSFI)

The OSFI instruction sets the OutputBit for one execution cycle when the

InputBit toggles from set to cleared.

This instruction is available in relay ladder as OSF, see page 94 .

Operands:

OSFI(OSFI_tag);

Structured Text

Operand

OSFI tag

Type

FBD_ONESHOT

Format

structure

Description

OSFI structure

Input Parameter

EnableIn

Data Type

BOOL

InputBit BOOL


EnableOut

OutputBit

Data Type

BOOL

BOOL

Function Block

Operand

OSFI tag

Type

FBD_ONESHOT

Format

structure

Description

OSFI structure

FBD_ONESHOT Structure

Description

Function Block:



Default is set.



Input bit. This is equivalent to rung condition for the relay ladder OSF instruction

Default is cleared.

Description


Output bit



99


Description:

When the InputBit is cleared and the InputBit

n-1

is set, the OSFI instruction sets the OutputBit. When InputBit

n-1

is cleared or when InputBit is set, the

OSFI instruction clears the OutputBit.

InputBit

InputBit n-1

OutputBit instruction is executed instruction resets during next scan execution

Condition


EnableIn is cleared



not affected


none

Execution:


No action taken.

InputBit

n-1

is cleared.

InputBit

n-1

is cleared.


On a cleared to set transition of InputBit, the instruction clears InputBit n-1

.


EnableOut is set.

No action taken.


No action taken.

InputBit

n-1

is cleared.

InputBit

n-1

is cleared.

na

On a cleared to set transition of InputBit, the instruction clears InputBit n-1

.



No action taken.

40047

100




Example:

When limit_switch1 goes from set to cleared, the OSFI instruction sets

OutputBit for one scan.

Structured Text

OSFI_01.InputBit := limit_switch1;

OSFI(OSFI_01);

Output_state := OSFI_01.OutputBit;

Function Block



101


Notes:

102



Chapter

3

Timer and Counter Instructions

(TON, TOF, RTO, TONR, TOFR, RTOR, CTU, CTD, CTUD, RES)

Introduction

time how long a timer is disabled with built-in reset in function block accumulate time with built-in reset in function block count up count down count up and count down in function block reset a timer or counter

Timers and counters control operations based on time or the number of events.

If You Want To

time how long a timer is enabled time how long a timer is disabled accumulate time time how long a timer is enabled with built-in reset in function block


TON

TOF

RTO

TONR

TOFR

RTOR

CTU

CTD

CTUD


relay ladder relay ladder relay ladder structured text function block structure text function block structured text function block relay ladder relay ladder structured text function block relay ladder RES

The time base for all timers is 1 msec.

See Page

104

108

112

116

120

124

128

132

136

141



103

Chapter 3 Timer and Counter Instructions (TON, TOF, RTO, TONR, TOFR, RTOR, CTU, CTD, CTUD, RES)

Timer On Delay (TON)

Mnemonic

.EN

.TT

.DN

.PRE

.ACC

The TON instruction is a non-retentive timer that accumulates time when the instruction is enabled (rung-condition-in is true).

This instruction is available in structured text and function block as TONR, see page 116 .

Operands:

Relay Ladder

Operand

Timer

Preset

Accum

Type

TIMER

DINT

DINT

Format Description

tag timer structure immediate how long to delay (accumulate time) immediate total msec the timer has counted initial value is typically 0

TIMER Structure

Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the TON instruction is enabled.

The timing bit indicates that a timing operation is in process

The done bit is set when .ACC

≥

.PRE.

The preset value specifies the value (1 msec units) which the accumulated value must reach before the instruction sets the .DN bit.

The accumulated value specifies the number of milliseconds that have elapsed since the

TON instruction was enabled.

Description:

The TON instruction accumulates time until:

• the TON instruction is disabled

• the .ACC

≥

.PRE

The time base is always 1 msec. For example, for a 2-second timer, enter 2000 for the .PRE value.

104



Timer and Counter Instructions (TON, TOF, RTO, TONR, TOFR, RTOR, CTU, CTD, CTUD, RES) Chapter 3

When the TON instruction is disabled, the .ACC value is cleared.

rung condition in timer enable bit (.EN) timer timing bit (.TT) timer done bit (.DN)

ON delay preset timer did not reach

.PRE value timer accumulated value (.ACC)

0 16649

A timer runs by subtracting the time of its last scan from the time now:

ACC = ACC + (current_time - last_time_scanned)

After it updates the ACC, the timer sets last_time_scanned =

current_time. This gets the timer ready for the next scan.

IMPORTANT

Make sure to scan the timer at least every 69 minutes while it runs. Otherwise, the ACC value won’t be correct.

The

last_time_scanned value has a range of up to 69 minutes. The timer’s calculation rolls over if you don’t scan the timer within 69 minutes. The ACC value won’t be correct if this happens.

While a timer runs, scan it within 69 minutes if you put it in a:

• subroutine

• section of code that is between JMP and LBL instructions

• sequential function chart (SFC)

• event or periodic task

• state routine of a phase


not affected


A Major Fault Will Occur If Fault Type

.PRE < 0 4

.ACC < 0 4

Fault Code

34

34



105


Condition


Execution:


The .EN, .TT, and .DN bits are cleared.

The .ACC value is cleared.





rung-condition-in is true examine .DN bit

.DN bit = 1

.DN bit = 0

.EN bit is set

.TT bit is set examine .EN bit

.EN bit = 0

.EN bit = 1

.TT bit is set

.ACC = .ACC + (current_time - last_time) examine .ACC

.ACC

≥

.PRE

.ACC < .PRE

.DN is set

.TT bit is cleared

.ACC value rolls over yes

.ACC = 2,147,483,647 no rung-condition-out is set to

true

postscan The rung-condition-out is set to false.

end

106




Example:

When limit_switch_1 is set, light_2 is on for 180 msec (timer_1 is timing). When

timer_1.acc reaches 180, light_2 goes off and light_3 goes on. Light_3 remains on until the TON instruction is disabled. If limit_switch_1 is cleared while timer_1 is timing, light_2 goes off.



107


Timer Off Delay (TOF)

Mnemonic

.EN

.TT

.DN

.PRE

.ACC

The TOF instruction is a non-retentive timer that accumulates time when the instruction is enabled (rung-condition-in is false).

This instruction is available in structured text and function block as TOFR, see page 120 .

Operands:

Relay Ladder

Operand

Timer

Preset

Accum

Type

TIMER

DINT

DINT


tag timer structure immediate how long to delay (accumulate time) immediate total msec the timer has counted initial value is typically 0

TIMER Structure

Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the TOF instruction is enabled.


The done bit is cleared when .ACC

≥

.PRE.

The preset value specifies the value (1 msec units) which the accumulated value must reach before the instruction clears the .DN bit.

The accumulated value specifies the number of milliseconds that have elapsed since the TOF instruction was enabled.

Description:

The TOF instruction accumulates time until:

• the TOF instruction is disabled

• the .ACC

≥

.PRE


108




When the TOF instruction is disabled, the .ACC value is cleared.

rung condition in timer enable bit (.EN) timer timing bit (.TT) timer done bit (.DN)

OFF delay preset timer accumulated value (.ACC)

0

16650 timer did not reach .PRE value





IMPORTANT


The



• subroutine






not affected



.PRE < 0

.ACC < 0

4

4

Execution:

Fault Code

34

34



109


Condition

prescan



The .ACC value is set to equal the .PRE value.


rung-condition-in is false examine .DN bit

.DN bit = 0

.DN bit = 1 examine .EN bit

.EN bit = 1

.EN bit = 0

.TT bit is set

.ACC = .ACC + (current_time - last_time)

.EN bit is cleared

.TT bit is set examine .ACC

.ACC

≥

.PRE

.ACC < .PRE

.DN is cleared

.TT bit is cleared

.ACC value rolls over yes

.ACC = 2,147,483,647 no rung-condition-in is true postscan rung-condition-out is set to

false

The .EN, .TT, and .DN bits are set.




end

110




Example:

When limit_switch_2 is cleared, light_2 is on for 180 msec (timer_2 is timing).

When timer_2.acc reaches 180, light_2 goes off and light_3 goes on. Light_3 remains on until the TOF instruction is enabled. If limit_switch_2 is set while

timer_2 is timing, light_2 goes off.



111


Retentive Timer On (RTO)

The RTO instruction is a retentive timer that accumulates time when the instruction is enabled.

This instruction is available in structured text and function block as RTOR, see page 124 .

Operands:

Relay Ladder

Operand

Timer

Preset

Accum

Type

TIMER

DINT

DINT


tag timer structure immediate how long to delay (accumulate time) immediate number of msec the timer has counted initial value is typically 0

TIMER Structure

Mnemonic

.EN

.TT

.DN

.PRE

.ACC

Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the RTO instruction is enabled.


The done bit indicates that .ACC

≥

.PRE.

The preset value specifies the value (1 msec units) which the accumulated value must reach before the instruction sets the .DN bit.

The accumulated value specifies the number of milliseconds that have elapsed since the RTO instruction was enabled.

Description:

The RTO instruction accumulates time until it is disabled. When the RTO instruction is disabled, it retains its .ACC value. You must clear the .ACC value, typically with a RES instruction referencing the same TIMER structure.

112





rung condition in timer enable bit (.EN) rung condition that controls RES instruction timer timing bit (.TT) timer done bit (.DN) preset

16651 timer accumulated value (.ACC)

0 timer did not reach .PRE value





IMPORTANT


The



• subroutine






not affected



.PRE < 0 4

.ACC < 0 4

Fault Code

34

34



113


Execution:

Condition




The .ACC value is not modified.


The .EN and .TT bits are cleared.

The .DN bit is not modified.

The .ACC value is not modified.


rung-condition-in is true postscan examine .DN bit

.DN bit = 1

.DN bit = 0 examine .EN bit

.EN bit = 0

.EN bit = 1

.TT bit is set

.ACC = .ACC + (current_time - last_time)

.EN bit is set

.TT bit is set examine .ACC

.ACC

≥

.PRE

.ACC < .PRE

.DN is set

.TT bit is cleared

.ACC value rolls over no yes

.ACC = 2,147,483,647


rung-condition-out is set to

true

end

114




Example:

When limit_switch_1 is set, light_1 is on for 180 msec (timer_2 is timing). When

timer_3.acc reaches 180, light_1 goes off and light_2 goes on. Light_2 remains until timer_3 is reset. If limit_switch_2 is cleared while timer_3 is timing, light_1 remains on. When limit_switch_2 is set, the RES instruction resets timer_3

(clears status bits and .ACC value).



115


Timer On Delay with Reset

(TONR)

The TONR instruction is a non-retentive timer that accumulates time when

TimerEnable is set.

This instruction is available in relay ladder as two separate instructions: TON

(see page 104 ) and RES (see page 141 ).

Operands:

TONR(TONR_tag);

Structured Text

Variable

TONR tag

Type

FBD_TIMER

Format

structure

Description

TONR structure

Function Block

Operand

TONR tag

Type

FBD_TIMER

Format

structure

Description

TONR structure

Input Parameter

EnableIn

TimerEnable

PRE

Reset

Data Type

BOOL

BOOL

DINT

BOOL


EnableOut

ACC

EN

TT

Data Type

BOOL

BOOL

BOOL

BOOL

FBD_TIMER Structure

Description

Function Block:



Default is set.



If set, this enables the timer to run and accumulate time.

Default is cleared.

Timer preset value. This is the value in 1msec units that ACC must reach before timing is finished. If invalid, the instruction sets the appropriate bit in Status and the timer does not execute.

Valid = 0 to maximum positive integer

Request to reset the timer. When set, the timer resets.

Default is cleared.

Description


Accumulated time in milliseconds.

Timer enabled output. Indicates the timer instruction is enabled.

Timer timing output. When set, a timing operation is in progress.

116




Input Parameter

DN

Data Type

BOOL

Status DINT


PresetInv (Status.1) BOOL

Description

Timing done output. Indicates when the accumulated time is greater than or equal to the preset value.

Status of the function block.

The instruction detected one of the following execution errors. This is not a minor or major controller error. Check the remaining status bits to determine what occurred.

The preset value is invalid.

Description:

The TONR instruction accumulates time until the:

•

TONR instruction is disabled

•

ACC

≥

PRE

The time base is always 1 msec. For example, for a 2-second timer, enter 2000 for the PRE value.

TimerEnable enable bit (EN) timer timing bit (TT) timer done bit (DN) timer did not reach PRE value

ON delay preset timer accumulated value (ACC)

0

16649

Set the Reset input parameter to reset the instruction. If TimerEnable is set when Reset is set, the TONR instruction begins timing again when Reset is cleared.





117




IMPORTANT


The



• subroutine





Condition

prescan instruction first scan reset postscan


not affected


none instruction first run

EnableIn is cleared

EnableIn is set

Execution:


No action taken.

EN, TT and DN are cleared.

ACC value is set to 0.




When EnableIn transitions from cleared to set, the instruction initializes as described for instruction first scan.


EnableOut is set.

When the Reset input parameter is set, the instruction clears EN, TT and DN and sets

ACC = zero.

No action taken.


No action taken.





na




ACC = zero.

No action taken.

118




Example:

Each scan that limit_switch1 is set, the TONR instruction increments the ACC value by elapsed time until the ACC value reaches the PRE value. When ACC

≥

PRE, the DN parameter is set, and timer_state is set.

Structured Text

TONR_01.Preset := 500;

TONR_01.Reset : = reset;

TONR_O1.TimerEnable := limit_switch1;

TONR(TONR_01); timer_state := TONR_01.DN;

Function Block Example



119


Timer Off Delay with Reset

(TOFR)

The TOFR instruction is a non-retentive timer that accumulates time when

TimerEnable is cleared.

This instruction is available in relay ladder as two separate instructions: TOF


Operands:

TOFR(TOFR_tag);

Structured Text

Variable

TOFR tag

Type

FBD_TIMER

Format

structure

Description

TOFR structure

Function Block Operands

Operand

TOFR tag

Type

FBD_TIMER


Format

structure

Description

TOFR structure

Input Parameter

EnableIn

TimerEnable

PRE

Reset

Data Type

BOOL

BOOL

DINT

BOOL


EnableOut

ACC

EN

Data Type

BOOL

BOOL

BOOL

Description

Function Block:



Default is set.



If cleared, this enables the timer to run and accumulate time.

Default is cleared.

Timer preset value. This is the value in 1msec units that ACC must reach before timing is finished. If invalid, the instructions sets the appropriate bit in Status and the timer does not execute.



Default is cleared.

Description


Accumulated time in milliseconds.


120




Input Parameter

TT

DN

Data Type

BOOL

BOOL

Status DINT



Description


Timing done output. Indicates when accumulated time is greater than or equal to preset.




Description:

The TOFR instruction accumulates time until the:

•

TOFR instruction is disabled

•

ACC

≥

PRE


TimerEnable enable bit (EN) timer timing bit (TT) timer done bit (DN)

OFF delay preset timer accumulated value (ACC)

0

16650 timer did not reach PRE value

Set the Reset input parameter to reset the instruction. If TimerEnable is cleared when Reset is set, the TOFR instruction does not begin timing again when Reset is cleared.





121




IMPORTANT


The



• subroutine





Condition

prescan instruction first scan reset postscan


not affected


none instruction first run

EnableIn is cleared

EnableIn is set

Execution:


No action taken.


ACC value is set to PRE.






EnableOut is set.


ACC = PRE. Note that this is different than using a

RES instruction on a TOF instruction.

No action taken.


No action taken.





na




ACC = PRE. Note that this is different than using a

RES instruction on a TOF instruction.

No action taken.

Example:

Each scan after limit_switch1 is cleared, the TOFR instruction increments the

ACC value by elapsed time until the ACC value reaches the PRE value. When

ACC

≥

PRE, the DN parameter is cleared, and timer_state2 is set.

122




Structured Text

TOFR_01.Preset := 500

TOFR_01.Reset := reset;

TOFR_O1.TimerEnable := limit_switch1;

TOFR(TOFR_01); timer_state2 := TOFR_01.DN;

Function Block



123


Retentive Timer On with

Reset (RTOR)

The RTOR instruction is a retentive timer that accumulates time when

TimerEnable is set.

This instruction is available in relay ladder as two separate instructions: RTO


Operands:

RTOR(RTOR_tag);

Structured Text

Variable

RTOR tag

Type

FBD_TIMER

Format

structure

Description

RTOR structure

Function Block Operands

Operand

RTOR tag

Type

FBD_TIMER


Format

structure

Description

RTOR structure

Input Parameter

EnableIn

TimerEnable

PRE

Data Type

BOOL

BOOL

DINT

Reset


EnableOut

ACC

EN

TT

BOOL

Data Type

BOOL

DINT

BOOL

BOOL

Description

Function Block:



Default is set.



If set, this enables the timer to run and accumulate time.

Default is cleared.

Timer preset value. This is the value in 1msec units that ACC must reach before timing is finished. If invalid, the instruction sets the appropriate bit in Status and the timer does not execute.



Description


Accumulated time in milliseconds. This value is retained even while the TimerEnable input is cleared. This makes the behavior of this block different than the TONR block.



124




Input Parameter

DN

Status

Data Type

BOOL

DINT



Description

Timing done output. Indicates when accumulated time is greater than or equal to preset.




Description:

The RTOR instruction accumulates time until it is disabled. When the RTOR instruction is disabled, it retains its ACC value. You must clear the .ACC value using the Reset input.


TimerEnable enable bit (EN)

Reset timer timing bit (TT) timer done bit (DN) preset

16651 timer accumulated value (ACC)

0 timer did not reach PRE value

Set the Reset input parameter to reset the instruction. If TimerEnable is set when Reset is set, the RTOR instruction begins timing again when Reset is cleared.





125




IMPORTANT


The



• subroutine





EnableIn is cleared

EnableIn is set reset postscan


not affected


none

Execution:

Condition



No action taken.

EN, TT and DN are cleared

ACC value is not modified




Function Block:



EnableOut is set.


ACC = zero.

No action taken.


No action taken.




ACC value is not modified na




ACC = zero.

No action taken.

126




Example:

Each scan that limit_switch1 is set, the RTOR instruction increments the ACC value by elapsed time until the ACC value reaches the PRE value. When ACC

≥

PRE, the DN parameter is set, and timer_state3 is set.

Structured Text

RTOR_01.Preset := 500

RTOR_01.Reset := reset;

RTOR_O1.TimerEnable := limit_switch1;

RTOR(RTOR_01); timer_state3 := RTOR_01.DN;

Function Block



127


Count Up (CTU)

Mnemonic

.CU

.DN

.OV

.UN

.PRE

.ACC

The CTU instruction counts upward.

This instruction is available in structured text and function block as CTUD, see page 136 .

Data Type

BOOL

BOOL

BOOL

BOOL

DINT

DINT

Operands:

Relay Ladder

Operand

Counter

Preset

Accum

Type

COUNTER

DINT

DINT

Format

tag

Description

counter structure immediate how high to count immediate number of times the counter has counted initial value is typically 0

COUNTER Structure

Description

The count up enable bit indicates that the CTU instruction is enabled.


≥

.PRE.

The overflow bit indicates that the counter exceeded the upper limit of 2,147,483,647. The counter then rolls over to -2,147,483,648 and begins counting up again.

The underflow bit indicates that the counter exceeded the lower limit of -2,147,483,648. The counter then rolls over to 2,147,483,647 and begins counting down again.

The preset value specifies the value which the accumulated value must reach before the instruction sets the .DN bit.

The accumulated value specifies the number of transitions the instruction has counted.

128




Description:

When enabled and the .CU bit is cleared, the CTU instruction increments the counter by one. When enabled and the .CU bit is set, or when disabled, the

CTU instruction retains its .ACC value.

rung condition in count-up enable bit (.CU) count-up done bit (.DN) preset counter accumulated value (.ACC)

16636

The accumulated value continues incrementing, even after the .DN bit is set.

To clear the accumulated value, use a RES instruction that references the counter structure or write 0 to the accumulated value.


not affected


none



129


Execution:

Condition



The .CU bit is set to prevent invalid increments during the first program scan.


The .CU bit is cleared.


examine .CU bit

.CU bit = 1

.CU bit = 0

.CU bit is set

.ACC = .ACC + 1

.ACC value rolls over no yes examine .UN bit

.UN bit = 0

.UN bit = 1

.UN bit is cleared

.DN bit is cleared

.UN bit = 1 examine .UN bit

.UN bit = 0 examine .OV bit

.OV bit = 0

.OV bit is set

.OV bit = 1 examine .ACC

.ACC

≥

.PRE

.ACC < .PRE

.DN bit is cleared

.DN bit is set postscan rung-condition-out is set to

true

end


130




Example:

After limit_switch_1 goes from disabled to enabled 10 times, the .DN bit is set and light_1 turns on. If limit_switch_1 continues to go from disabled to enabled,

counter_1 continues to increment its count and the .DN bit remains set. When limit_switch_2 is enabled, the RES instruction resets counter_1 (clears the status bits and the .ACC value) and light_1 turns off.



131


Count Down (CTD)

Mnemonic

.CD

.DN

.OV

.UN

.PRE

.ACC

The CTD instruction counts downward.

This instruction is available in structured text and function block as CTUD, see page 136 .

Data Type

BOOL

BOOL

BOOL

BOOL

DINT

DINT

Operands:

Relay Ladder

Operand

Counter

Preset

Accum

Type

COUNTER

DINT

DINT

Format

tag

Description

counter structure immediate how low to count immediate number of times the counter has counted initial value is typically 0

COUNTER Structure

Description

The count down enable bit indicates that the CTD instruction is enabled.


≥

.PRE.

The overflow bit indicates that the counter exceeded the upper limit of 2,147,483,647. The counter then rolls over to -2,147,483,648 and begins counting up again.

The underflow bit indicates that the counter exceeded the lower limit of -2,147,483,648. The counter then rolls over to 2,147,483,647 and begins counting down again.

The preset value specifies the value which the accumulated value must reach before the instruction sets the .DN bit.

The accumulated value specifies the number of transitions the instruction has counted.

132




Description:

The CTD instruction is typically used with a CTU instruction that references the same counter structure.

When enabled and the .CD bit is cleared, the CTD instruction decrements the counter by one. When enabled and the .CD bit is set, or when disabled, the

CTD instruction retains its .ACC value.

rung condition in count-down enable bit (.CD) count-down done bit (.DN) counter accumulated value (.ACC) preset

16637

The accumulated value continues decrementing, even after the .DN bit is set.

To clear the accumulated value, use a RES instruction that references the counter structure or write 0 to the accumulated value.


not affected


none



133


Execution:

Condition



The .CD bit is set to prevent invalid decrements during the first program scan.


The .CD bit is cleared.


examine .CD bit

.CD bit = 1

.CD bit = 0

.CD bit is set

.ACC = .ACC - 1

.ACC value rolls over no yes examine .UN bit

.UN bit = 0

.UN bit = 1 examine .OV bit

.OV bit = 0

.OV bit is cleared

.DN bit is cleared

.OV bit = 1 examine .OV bit

.OV bit = 0

.UN bit is set

.OV bit = 1 examine .ACC

.ACC

≥

.PRE

.ACC < .PRE

.DN bit is cleared

.DN bit is set postscan rung-condition-out is set to

true

end


134




Example:

A conveyor brings parts into a buffer zone. Each time a part enters,

limit_switch_1 is enabled and counter_1 increments by 1. Each time a part leaves,

limit_switch_2 is enabled and counter_1 decrements by 1. If there are 100 parts in the buffer zone (counter_1.dn is set), conveyor_a turns on and stops the conveyor from bringing in any more parts until the buffer has room for more parts.



135


Count Up/Down (CTUD)

The CTUD instruction counts up by one when CUEnable transitions from clear to set. The instruction counts down by one when CDEnable transitions from clear to set.

This instruction is available in relay ladder as three separate instructions: CTU

(see page 128 ), CTD (see page 132 ), and RES (see page 141 ).

Operands:

CTUD(CTUD_tag);

Structured Text

Variable

CTUD tag

Type

FBD_COUNTER

Format

structure

Description

CTUD structure

Function Block

Operand

CTUD tag

Type

FBD_COUNTER

Format

structure

Description

CTUD structure

Input Parameter

EnableIn

Data Type

BOOL

CUEnable BOOL

FBD_COUNTER Structure

Description

Function Block:



Default is set.



Enable up count. When input toggles from clear to set, accumulator counts up by one.

Default is cleared.

136




Input Parameter

CDEnable

Data Type

BOOL

PRE DINT

Reset BOOL

Description

Enable down count. When input toggles from clear to set, accumulator counts down by one.

Default is cleared.

Counter preset value. This is the value the accumulated value must reach before DN is set.

Valid = any integer

Default is 0.

Request to reset the timer. When set, the counter resets.

Default is cleared.

CU

CD

DN

OV


EnableOut

ACC

Data Type

BOOL

DINT

BOOL

BOOL

BOOL

BOOL

UN BOOL

Description


Accumulated value.

Count up enabled.

Count down enabled.

Counting done. Set when accumulated value is greater than or equal to preset.

Counter overflow. Indicates the counter exceeded the upper limit of 2,147,483,647.

The counter then rolls over to

−

Counter underflow. Indicates the counter exceeded the lower limit of

−

The counter then rolls over to 2,147,483,647 and begins counting down again.

Description

When enabled and CUEnable is set, the CTUD instructions increments the counter by one. When enabled and CDEnable is set, the CTUD instruction decrements the counter by one.

Both the CUEnable and CDEnable input parameters can both be toggled during the same scan. The instruction executes the count up prior to the count down.



137


Counting Up

CUEnable count-up enable bit (CU) count-up done bit (DN) preset counter accumulated value (ACC)

Counting Down

CDEnable count-down enable bit (CD) count-down done bit (DN)

16636 counter accumulated value (ACC) preset

16637

When disabled, the CTUD instruction retains its accumulated value. Set the

Reset input parameter of the FBD_COUNTER structure to reset the instruction.


not affected


none

138




Condition


EnableIn is cleared

EnableIn is set reset postscan

Execution:


No initialization required.

CUEnable n-1

and CDEnable n-1

are set.

CUEnable n-1

and CDEnable n-1

are set.


The instruction sets CUEnable n-1

and CDEnable n-1

.

On a cleared to set transition of EnableIn:

•


•

EnableOut is set.

When set, the instruction clears CUEnable n-1

,

CDEnable n-1

, CU, CD, DN, OV, and UN and sets

ACC = zero.

No action taken.


No initialization required.

CUEnable n-1

and CDEnable n-1

are set.

CUEnable n-1

and CDEnable n-1

are set.

na

The instruction sets CUEnable



n-1

and CDEnable

When set, the instruction clears CUEnable n-1

,

CDEnable n-1

, CU, CD, DN, OV, and UN and sets

ACC = zero.

No action taken.

n-1

.

Example:

When limit_switch1 goes from cleared to set, CUEnable is set for one scan and the CTUD instruction increments the ACC value by 1. When ACC

≥

PRE, the

DN parameter is set, which enables the function block instruction following the CTUD instruction.

Structured Text

CTUD_01.Preset := 500;

CTUD_01.Reset := Restart;

CTUD_O1.CUEnable := limit_switch1;

CTUD(CTUD_01); counter_state := CTUD_01.DN;

Function Block



139


140



Reset (RES)


The RES instruction resets a TIMER, COUNTER, or CONTROL structure.

Operands:

Relay Ladder

Operand

structure

Type

TIMER

CONTROL

COUNTER

Format

tag

Description

structure to reset

Description:

When enabled the RES instruction clears these elements:

The Instruction Clears When Using a Res

Instruction For a

TIMER

COUNTER

CONTROL

.ACC value control status bits

.ACC value control status bits

.POS value control status bits

ATTENTION

Because the RES instruction clears the .ACC value, .DN bit, and

.TT bit, do not use the RES instruction to reset a TOF timer.

Condition

prescan


not affected


none

Execution:





141


Condition

rung-condition-in is false rung-condition-in is true postscan



The RES instruction resets the specified structure.



142



Chapter

4

Input/Output Instructions

(MSG, GSV, SSV, IOT)

Introduction

If You Want To

send data to or from another module get controller status information set controller status information

• send output values to an I/O module or consuming controller at a specific point in your logic

• trigger an event task in another controller

The input/output instructions read or write data to or from the controller or a block of data to or from another module on another network.


MSG

GSV

SSV

IOT


relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text

See Page

144

176

176

201



143

Chapter 4 Input/Output Instructions (MSG, GSV, SSV, IOT)

Message (MSG)

Operands:

The MSG instruction asynchronously reads or writes a block of data to another module on a network.

MSG(MessageControl);

Relay Ladder

Operand

Message control

Type Format

MESSAGE tag

Description

message structure

Structured Text

The operands are the same as those for the relay ladder MSG instruction.

MESSAGE Structure

ATTENTION

If you check the status bits more than once

The controller changes the DN, ER, EW, and ST bits asynchronous to the scan of your logic. Use a copy of the bits if you check them in more than one place in your logic. Otherwise, the bits may change during the scan and your logic won’t work as you expect it.

One way to make a copy is to use the FLAGS word. Copy the FLAGS word to another tag and check the bits in the copy.

IMPORTANT

Do not change the following status bits of a MSG instruction:

•

DN

•

EN

•

ER

•

EW

•

ST

Do not change those bits either by themselves or as part of the FLAGS word. If you do, the controller may have a non-recoverable fault. The controller clears the project from its memory when it has a non-recoverable fault.

144



Input/Output Instructions (MSG, GSV, SSV, IOT) Chapter 4

Mnemonic

.FLAGS

.ERR

.EXERR

.REQ_LEN

.DN_LEN

.EW

.ER

.DN

.ST

.EN

.TO

.EN_CC

.ERR_SRC

.DestinationLink

INT

INT

INT

INT

BOOL

Data

Type

INT

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

SINT

INT

Description

The FLAGS member provides access to the status members (bits) in one 16-bit word.

This bit: Is this member:

2 .EW

6

7

4

5

.ER

.DN

.ST

.EN

8

9

.TO

.EN_CC

Important: Do not change the EW, ER, DN, or ST bits of the FLAGS member. For example, do not clear the entire FLAGS word. The controller ignores the change and uses the internally-stored values of the bits.

If the .ER bit is set, the error code word identifies error codes for the MSG instruction.

The extended error code word specifies additional error code information for some error codes.

The requested length specifies how many words the message instruction will attempt to transfer.

The done length identifies how many words actually transferred.

The enable waiting bit is set when the controller detects that a message request has entered the queue. The controller resets the.EW bit when the .ST bit is set.

Important: Do not change the EW bit. The controller ignores the change and uses the internally-stored value of the bit.

The error bit is set when the controller detects that a transfer failed. The .ER bit is reset the next time the rung-condition-in goes from false to true.

Important: Do not change the ER bit.

The done bit is set when the last packet of the message is successfully transferred. The .DN bit is reset the next time the rung-condition-in goes from false to true.

Important: Do not change the DN bit.

The start bit is set when the controller begins executing the MSG instruction. The .ST bit is reset when the .DN bit or the .ER bit is set.

Important: Do not change the ST bit. The controller ignores the change and uses the internally-stored value of the bit.

The enable bit is set when the rung-condition-in goes true and remains set until either the .DN bit or the .ER bit is set and the rung-condition-in is false. If the rung-condition-in goes false, but the .DN bit and the .ER bit are cleared, the .EN bit remains set.

Important: Do not change the EN bit.

If you manually set the .TO bit, the controller stops processing the message and sets the .ER bit.

The enable cache bit determines how to manage the MSG connection. Refer to Choose a cache option on page 4-173 Connections for MSG instructions going out the serial port are not cached, even if the .EN_CC bit is set.

Used by RSLogix 5000 software to show the error path on the Message Configuration dialog box

To change the Destination Link of a DH+ or CIP with Source ID message, set this member to the required value.



145


Mnemonic

.DestinationNode

.SourceLink

.Class

.Attribute

.Instance

.LocalIndex

.Channel

.Rack

.Group

.Slot

.Path

.RemoteIndex

.RemoteElement

146

Data

Type

INT

INT

INT

INT

DINT

DINT

Description

To change the Destination Node of a DH+ or CIP with Source ID message, set this member to the required value.

To change the Source Link of a DH+ or CIP with Source ID message, set this member to the required value.

To change the Class parameter of a CIP Generic message, set this member to the required value.

To change the Attribute parameter of a CIP Generic message, set this member to the required value.

To change the Instance parameter of a CIP Generic message, set this member to the required value.

If you use an asterisk [*] to designate the element number of the local array, the LocalIndex provides the element number. To change the element number, set this member to the required value.

SINT

SINT

SINT

If the message:

reads data

Then the local array is the:

Destination element writes data Source element

To send the message out a different channel of the 1756-DHRIO module, set this member to the required value. Use either the ASCII character A or B.

To change the rack number for a block transfer message, set this member to the required rack number (octal).

To change the group number for a block transfer message, set this member to the required group number (octal).

To change the slot number for a block transfer message, set this member to the required slot number.

SINT

If the message goes over this network:

Then specify the slot number in:

universal remote I/O octal

ControlNet decimal (0-15)

STRING To send the message to a different controller, set this member to the new path.

•

Enter the path as hexadecimal values.

•

Omit commas [,]

For example, for a path of 1, 0, 2, 42, 1, 3, enter $01$00$02$2A$01$03.

DINT

To browse to a device and automatically create a portion or all of the new string, right-click a string tag and choose Go to Message Path Editor.

If you use an asterisk [*] to designate the element number of the remote array, the RemoteIndex provides the element number. To change the element number, set this member to the required value.

If the message: Then the remote array is the:

reads data Source element writes data Destination element

STRING To specify a different tag or address in the controller to which the message is sent, set this member to the required value. Enter the tag or address as ASCII characters.

If the message:

reads data writes data

Then the remote array is the:

Source element

Destination element




Mnemonic Data

Type

.UnconnnectedTimeout DINT

.ConnectionRate

.TimeoutMultiplier

DINT

SINT

Description

Time out for an unconnected message or for making a connection. The default value is 30 seconds.

If the message is Then

unconnected The ER bit turns on if the controller doesn’t get a response within the

UnconnectedTimeout time.

connected The ER bit turns on if the controller doesn’t get a response for making the connection within the UnconnectedTimeout time.

Time out for a connected message once it has a connection. This time out is for the response from the other device about the sending of the data.

•

This time out applies only after the connection is made.

•

The time out = ConnectionRate x TimeoutMultiplier.

•

The default ConnectionRate is 7.5 seconds.

•

The default TimeoutMultiplier is 0 (which is a multiplication factor of 4).

•

The default time out for connected messages is 30 seconds (7.5 seconds x 4 = 30 seconds).

•

To change the time out, change the ConnectionRate and leave the TimeoutMultiplier at the default value.

Description

The MSG instruction transfers elements of data.

This is a transitional instruction:

•

In relay ladder, toggle the rung-condition-in from cleared to set each time the instruction should execute.

•

In structured text, condition the instruction so that it only executes on a transition. See Appendix B.



147


The size of each element depends on the data types you specify and the type of message command you use.

connection with .EN_CC = 1 rung-condition -in

.EN bit

.EW bit connection with .EN_CC = 0

.ST bit

.DN bit or .ER bit

41382

1 2 3 4 5 6 7

148




Where

1

2

Description

rung-condition-in is true

.EN is set

.EW is set connection is opened* message is sent

.ST is set

.EW is cleared

3

4

Condition

prescan message is done or errored rung-condition-in is false

.DN or .ER is set

.ST is cleared connection is closed (if .EN_CC = 0)

.EN is cleared (rung-condition-in is false) rung-condition-in is true

.DN or .ER was previously set

.EN is set

.EW is set connection is opened*

.DN or .ER is cleared

Execution:



Where

5

Description

message is sent

.ST is set

.EW is cleared

6

7 message is done or errored rung-condition-in is still true

.DN or .ER is set

.ST is cleared connection is closed (if .EN_CC = 0) rung-condition-in goes false and .DN or .ER is set

.EN is cleared


No action taken.



149


Condition

rung-condition-in is false


.EN bit = 1

.EW bit = 1 examine .EW bit

.EW bit = 0

.ST bit = 1 examine .ST bit

.ST bit = 0


examine .EN bit

.EN bit = 0

.DN bit = examine .DN bit

.DN bit = 0

.ER bit = 1 examine .ER bit

.ER bit = 0 block-transfer command no yes

.DN bit = 1 examine .DN bit yes module path valid no yes module connection running no

.DN bit = 0

.EN bit is cleared

.ER bit = 1 examine .ER bit execute message request

.EW bit is set .ER bit is set

.ER bit = 0 rung-condition-out is set to false end rung-condition-in is true The instruction executes.


na

150




Condition

EnableIn is set instruction execution


na

.EN bit = 1 examine .EN bit

.EN bit = 0






.EW bit = 0

.EW bit = 1



.ST bit = 1

.ST bit = 0

.EW, .ST, .TO, .DN, and .ER bits are cleared

.DN bit = 1 examine .DN bit

.DN bit = 0

.EN bit is set

.ER bit = 1 examine .ER bit

.ER bit = 0 block-transfer command no yes module path valid yes no yes module connection running

.EW, .ST, .TO, .DN, and .ER bits are cleared

.EN bit is set

.ER bit is set no rung-condition-out is set to false end

No action taken.

postscan The rung-condition-out is set to false.



151



not affected


none

MSG Error Codes

The error codes depend on the type of MSG instruction.

000D

000E

000F

0010

0011

0012

0006

0007

0008

0009

000A

000B

000C

0013

0014

0015

001A

001B

001C

Error Code

(Hex)

0001

0002

0003

0004

0005

Error Codes

RSLogix 5000 software does not always display the full description.

Description Display In Software

Connection failure (see extended error codes)

Insufficient resource

Invalid value

IOI syntax error (see extended error codes)

Destination unknown, class unsupported, instance undefined or structure element undefined (see extended error codes)

Insufficient packet space

Connection lost

Service unsupported

Error in data segment or invalid attribute value

Attribute list error

State already exists

Object model conflict

Object already exists

Attribute not settable

Permission denied

Device state conflict

Reply will not fit

Fragment primitive

Insufficient command data

Attribute not supported

Too much data

Bridge request too large

Bridge response too large

Attribute list shortage same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description same as description

152



0026

0027

0028

0029

00D1

00FB

00FC

00FD

00FE

00FF

Error Code

(Hex)

001D

001E

001F

0022

0025

Description

Invalid attribute list

Embedded service error

Connection related failure (see extended error codes)

Invalid reply received

Key segment error

Invalid IOI error

Unexpected attribute in list

DeviceNet error - invalid member ID

DeviceNet error - member not settable

Module not in run state

Message port not supported

Message unsupported data type

Message uninitialized

Message timeout

General error (see extended error codes)


Display In Software

same as description same as description same as description same as description same as description same as description same as description same as description same as description unknown error unknown error unknown error unknown error unknown error unknown error



153


0109

0110

0111

0114

0115

0116

0118

011A

Extended

Error Code

(Hex)

0100

0103

0106

0107

0108

Description

Connection in use

Transport not supported

Ownership conflict

Connection not found

Invalid connection type

Invalid connection size

Module not configured

EPR not supported

Wrong module

Wrong device type

Wrong revision

Invalid configuration format

Application out of connections

Extended Error Codes

RSLogix 5000 software does not display any text for the extended error codes.

These are the extended error codes for error code 0001.

0302

0303

0305

0311

0312

0315

0317

Extended

Error Code

(Hex)

0203

0204

0205

0206

0301

Description

Connection timeout

Unconnected message timeout

Unconnected send parameter error

Message too large

No buffer memory

Bandwidth not available

No screeners available

Signature match

Port not available

Link address not available

Invalid segment type

Connection not scheduled

These are the extended error codes for error code 001F.

Description Extended Error

Code (Hex)

0203 Connection timeout

These are the extended error codes for error code 0004 and 0005.

Description Extended Error

Code (Hex)

0000

0001 extended status out of memory extended status out of instances

154




These are the extended error codes for error code 00FF.

2104

2105

2106

2107

2100

2101

2102

2103

Extended

Error Code

(Hex)

2001

2002

2018

201B

201C

Description

Excessive IOI

Bad parameter value

Semaphore reject

Size too small

Invalid size

Privilege failure

Invalid keyswitch position

Password invalid

No password issued

Address out of range

Address and how many out of range

Data in use

Type is invalid or not supported

210F

2110

2111

2112

2113

2114

Extended

Error Code

(Hex)

2108

2109

210A

210B

210E

Description

Controller in upload or download mode

Attempt to change number of array dimensions

Invalid symbol name

Symbol does not exist

Search failed

Task cannot start

Unable to write

Unable to read

Shared routine not editable

Controller in faulted mode

Run mode inhibited



155


PLC and SLC Error Codes (.ERR)

PLC and SLC Error Codes (hex)

00F0

00F0

00F0

00F0

0070

0080

0090

00B0

00F0

0030

0040

0050

0060

R9.x And Earlier

.ERR

.EXERR

0010

0020

0001

0002

0003

0004

0005

F002

F003

F004

F005

7000

8000

9000

B000

F001

3000

4000

5000

6000

R10.x And Later

.ERR

.EXERR

1000

2000

00F0

00F0

00F0

00F0

0006

0007

0008

0009

F006

F007

F008

F009

Logix firmware revision 10.x and later provides new error codes for errors that are associated with PLC and SLC message types (PCCC messages).

•

This change lets RSLogix 5000 software display a more meaningful description for many of the errors. Previously the software did not give a description for any of the errors associated with the 00F0 error code.

•

The change also makes the error codes more consistent with errors returned by other controllers, such as PLC-5 controllers.

The following table shows the change in the error codes from R9.x and earlier to R10.x and later. As a result of the change, the .ERR member returns a unique value for each PCCC error. The .EXERR is no longer required for these errors.

Description

Illegal command or format from local processor

Communication module not working

Remote node is missing, disconnected, or shut down

Processor connected but faulted (hardware)

Wrong station number

Requested function is not available

Processor is in Program mode

Processor’s compatibility file does not exist

Remote node cannot buffer command

Processor is downloading so it is not accessible

Processor incorrectly converted the address

Incomplete address

Incorrect address

Illegal address format - symbol not found

Illegal address format - symbol has 0 or greater than the maximum number of characters supported by the device

Address file does not exist in target processor

Destination file is too small for the number of words requested

Cannot complete request

Situation changed during multipacket operation

Data or file is too large

Memory unavailable

156




00F0

00F0

00F0

00F0

00F0

00F0

00F0

00F0

00F0

PLC and SLC Error Codes (hex) (Continued)

R9.x And Earlier

.ERR

00F0

.EXERR

000A

00F0

00F0

00F0

00F0

00F0

00F0

00F0

00F0

00F0

00F0

000F

0010

0011

0012

000B

000C

000D

000E

0013

0014

F00F

F010

F011

F012

F013

F014

R10.x And Later

.ERR

F00A

.EXERR

F00B

F00C

F00D

F00E

0015

0016

0017

0018

0019

001A

001B

001C

001D

F015

F016

F017

F018

F019

F01A

F01B

F01C

F01D

Description

Target processor cannot put requested information in packets

Privilege error; access denied

Requested function is not available

Request is redundant

Command cannot be executed

Overflow; histogram overflow

No access

Data type requested does not match data available

Incorrect command parameters

Address reference exists to deleted area

Command execution failure for unknown reason

PLC-3 histogram overflow

Data conversion error

The scanner is not available to communicate with a 1771 rack adapter

The adapter is no available to communicate with the module

The 1771 module response was not valid

Duplicate label

File owner active - the file is being used

Program owner active - someone is downloading or editing online

Disk file is write protected or otherwise not accessible (offline only)

Disk file is being used by another application

Update not performed (offline only)



157


00D3

00D6

00EA

00EB

00EC

Error Code

(Hex)

00D0

00D1

00D2

00ED

00EE

00EF

00F0

00F3

00F5

00F6

00F7

00F8

00F9

00FA

00FB

00FC

00FD

Block-Transfer Error Codes

These are the Logix5000 block-transfer specific error codes.

Description Display In Software

The scanner did not receive a block-transfer response from the block-transfer module within 3.5 seconds of the request

The checksum from the read response did not match the checksum of the data stream

The scanner requested either a read or write but the block-transfer module responded with the opposite

The scanner requested a length and the block-transfer module responded with a different length

The scanner received a response from the block-transfer module indicating the write request failed

The scanner was not configured to communicate with the rack that would contain this block-transfer module

The logical slot specified is not available for the given rack size unknown error unknown error unknown error unknown error unknown error unknown error unknown error unknown error There is currently a block-transfer request in progress and a response is required before another request can begin

The size of the block-transfer request is not consistent with valid block-transfer size requests unknown error

The type of block-transfer request is not consistent with the expected BT_READ or BT_WRITE

The scanner was unable to find an available slot in the block-transfer table to accommodate the block-transfer request unknown error unknown error

The scanner received a request to reset the remote I/O channels while there were outstanding block-transfers

Queues for remote block-transfers are full unknown error

No communication channels are configured for the requested rack or slot

No communication channels are configured for remote I/O

The block-transfer timeout, set in the instruction, timed out before completion

Error in block-transfer protocol - unsolicited block-transfer

Block-transfer data was lost due to a bad communication channel unknown error unknown error unknown error unknown error unknown error unknown error unknown error The block-transfer module requested a different length than the associated block-transfer instruction

The checksum of the block-transfer read data was wrong

There was an invalid transfer of block-transfer write data between the adapter and the block-transfer module

The size of the block-transfer plus the size of the index in the block-transfer data table was greater than the size of the block-transfer data table file unknown error unknown error unknown error

158




Specify the Configuration

Details

After you enter the MSG instruction and specify the MESSAGE structure, use the Message Configuration dialog box to specify the details of the message.

Click here to configure the MSG instruction

The details you configure depend on the message type you select.

If The Target Device Is a

Logix5000 controller

I/O module that you configure using

RSLogix 5000 software

PLC-5 controller

SLC controller

MicroLogix controller

Block-transfer module

PLC-3 processor

PLC-2 processor

Select One Of These Message Types

CIP Data Table Read

CIP Data Table Write

Module Reconfigure

CIP Generic

PLC5 Typed Read

PLC5 Typed Write

PLC5 Word Range Read

PLC5 Word Range Write

SLC Typed Read

SLC Typed Write

Block-Transfer Read

Block-Transfer Write

PLC3 typed read

PLC3 typed write

PLC3 word range read

PLC3 word range write

PLC2 unprotected read

PLC2 unprotected write

See Page

160

161

162

163

165

165

166

167

42976



159


For This Property

Source Element

Number of Elements

Destination Element

You must specify this configuration information.

Specify

•

If you select a read message type, the Source Element is the address of the data you want to read in the target device. Use the addressing syntax of the target device.

•

If you select a write message type, the Source Tag is the first element of the tag that you want to send to the target device.

The number of elements you read/write depends on the type of data you are using. An element refers to one

“chunk” of related data. For example, tag timer1 is one element that consists of one timer control structure.

•

If you select a read message type, the Destination Element is the first element of the tag in the Logix5000 controller where you want to store the data you read from the target device.

•

If you select a write message type, the Destination Element is the address of the location in the target device where you want to write the data.

Select This Command

CIP Data Table Read

CIP Data Table Write

Specify CIP Data Table Read and Write messages

The CIP Data Table Read and Write message types transfer data between

Logix5000 controllers.

If You Want To

read data from another controller.

The Source and Destination types must match.

write data to another controller.

The Source and Destination types must match.

160




Reconfigure an I/O module

Use the Module Reconfigure message to send new configuration information to an I/O module. During the reconfiguration:

•

Input modules continue to send input data to the controller.

•

Output modules continue to control their output devices.

A Module Reconfigure message requires this configuration properties.

In This Property

Message Type

Select

Module Reconfigure

Example:

To reconfigure an I/O module:

1.

Set the required member of the configuration tag of the module to the new value.

2.

Send a Module Reconfigure message to the module.

When reconfigure[5] is set, set the high alarm to 60 for the local module in slot 4.

The Module Reconfigure message then sends the new alarm value to the module. The one shot instruction prevents the rung from sending multiple messages to the module while the reconfigure[5] is on.

Relay Ladder

Structured Text

IF reconfigure[5] AND NOT reconfigure[6]THEN

Local:4:C.Ch0Config.HAlarmLimit := 60;

IF NOT change_Halarm.EN THEN

MSG(change_Halarm);

END_IF;

END_IF; reconfigure[6] := reconfigure[5];



161


Specify CIP Generic messages

Reset electronic fuses on a digital output module

A CIP Generic message performs a specific action on an I/O module.

If You Want To

Perform a pulse test on a digital output module


Message Type

Service Type

Source

Destination

Message Type

Service Type

Source

Reset latched diagnostics on a digital input module

Destination

Message Type

Service Type

Source

Reset latched diagnostics on a digital output module

Message Type

Service Type

Source

Type Or Select

CIP Generic

Pulse Test

tag_name of type INT [5]

This array contains:

tag_name[0]

tag_name[1]

tag_name[2]

tag_name[3] bit mask of points to test (test only one point at a time) reserved, leave 0 pulse width (hundreds of

μ secs, usually 20) zero cross delay for ControlLogix I/O

(hundreds of

μ secs, usually 40) verify delay tag_name[4] leave blank

CIP Generic

Reset Electronic Fuse

tag name of type DINT

This tag represents a bit mask of the points to reset fuses on.

leave blank

CIP Generic

Reset Latched Diagnostics (I)

tag_name of type DINT

This tag represents a bit mask of the points to reset diagnostics on.

CIP Generic

Reset Latched Diagnostics (O)

tag_name of type DINT

This tag represents a bit mask of the points to reset diagnostics on.

162




If You Want To

Unlatch the alarm of an analog input module


Message Type

Service Type

Unlatch the alarm of an analog output module

Instance

Message Type

Service Type

Instance

Type Or Select

CIP Generic

Select which alarm that you want to unlatch:

•

Unlatch All Alarms (I)

•

Unlatch Analog High Alarm (I)

•

Unlatch Analog High High Alarm (I)

•

Unlatch Analog Low Alarm (I)

•

Unlatch Analog Low Low Alarm (I)

•

Unlatch Rate Alarm (I)

Channel of the alarm that you want to unlatch

CIP Generic

Select which alarm that you want to unlatch:

•

Unlatch All Alarms (O)

•

Unlatch High Alarm (O)

•

Unlatch Low Alarm (O)

•

Unlatch Ramp Alarm (O)

Channel of the alarm that you want to unlatch


PLC5 Typed Read

PLC5 Typed Write



Specify PLC-5 messages

Use the PLC-5 message types to communicate with PLC-5 controllers.

If You Want To

Read 16-bit integer, floating-point, or string type data and maintain data integrity.

See Data types for PLC5 Typed Read and Typed Write messages on page 164 .

Write 16-bit integer, floating-point, or string type data and maintain data integrity.

See Data types for PLC5 Typed Read and Typed Write messages on page 164

Read a contiguous range of 16-bit words in PLC-5 memory regardless of data type.

This command starts at the address specified as the Source Element and reads sequentially the number of 16-bit words requested.

The data from the Source Element is stored, starting at the address specified as the

Destination Tag.

Write a contiguous range of 16-bit words from Logix5000 memory regardless of data type to PLC-5 memory.

This command starts at the address specified as the Source Tag and reads sequentially the number of 16-bit words requested.

The data from the Source Tag is stored, starting at the address specified as the

Destination Element in the PLC-5 processor.



163


Typed read command

16-bit words in

PLC-5 processor

1

2

3

4

The following table shows the data types to use with PLC5 Typed Read and

PLC5 Typed Write messages.

Data types for PLC5 Typed Read and Typed Write messages

For this PLC-5 data type

B

F

N

S

ST

Use this Logix5000 data type

INT

REAL

INT

DINT (Only write DINT values to a PLC-5 controller if the value is

≥ −

32,768 and

≤

32,767.)

INT

STRING

The Typed Read and Typed Write commands also work with SLC 5/03 processors (OS303 and above), SLC 5/04 processors (OS402 and above), and

SLC 5/05 processors.

The following diagrams show how the typed and word-range commands differ. The example uses read commands from a PLC-5 processor to a

Logix5000 controller.

32-bit words in


Word-range read command

16-bit words in

PLC-5 processor

32-bit words in


1

2

3

4

The typed commands maintain data structure and value.

1

2

3

4

2

4

1

3

The word-range commands fill the destination tag contiguously. Data structure and value change depending on the destination data type.

164




Specify SLC messages

Use the SLC message types to communicate with SLC and MicroLogix controllers. The following table shows which data types that the instruction lets you access. The table also shows the corresponding Logix5000 data type.

For this SLC or MicroLogix Data Type Use This Logix5000 Data Type

F REAL

L (MicroLogix 1200 and 1500 controllers)

N

DINT

INT

Specify block-transfer messages

The block-transfer message types are used to communicate with block-transfer modules over a Universal Remote I/O network.

If You Want To

read data from a block-transfer module.

This message type replaces the BTR instruction.

write data to a block-transfer module.

This message type replaces the BTW instruction.


Block-Transfer Read

Block-Transfer Write

To configure a block-transfer message, follow these guidelines:

•

The source (for BTW) and destination (for BTR) tags must be large enough to accept the requested data, except for MESSAGE, AXIS, and

MODULE structures.

•

Specify how many 16-bit integers (INT) to send or receive. You can specify from 0 to 64 integers.

If You Want The

Block-transfer module to determine how many

16-bit integers to send (BTR).

Controller to send 64 integers (BTW).

Then Specify

0 for the number of elements



165


Select this command

PLC3 Typed Read

PLC3 Typed Write




The PLC-3 message types are designed for PLC-3 processors.

If you want to

read integer or REAL type data.

For integers, this command reads 16-bit integers from the PLC-3 processor and stores them in SINT, INT, or DINT data arrays in the Logix5000 controller and maintains data integrity.

This command also reads floating-point data from the PLC-3 and stores it in a REAL data type tag in the Logix5000 controller.

write integer or REAL type data.

This command writes SINT or INT data, to the PLC-3 integer file and maintains data integrity. You can write DINT data as long as it fits within an INT data type ( 32,768

≥ data

≤

32,767).

This command also writes REAL type data from the Logix5000 controller to a PLC-3 floating-point file.

read a contiguous range of 16-bit words in PLC-3 memory regardless of data type.

This command starts at the address specified as the Source Element and reads sequentially the number of 16-bit words requested.

The data from the Source Element is stored, starting at the address specified as the

Destination Tag.

write a contiguous range of 16-bit words from Logix5000 memory regardless of data type to PLC-3 memory.

This command starts at the address specified as the Source Tag and reads sequentially the number of 16-bit words requested.

The data from the Source Tag is stored, starting at the address specified as the

Destination Element in the PLC-3 processor.

166




Typed read command

16-bit words in

PLC-3 processor

1

2

3

4

32-bit words in

The following diagrams show how the typed and word-range commands differ. The example uses read commands from a PLC-3 processor to a

Logix5000 controller.


1

2

3

4

The typed commands maintain data structure and value.

Word-range read command

16-bit words in

PLC-3 processor

1

32-bit words in


2 1

2

3

4

4 3

The word-range commands fill the destination tag contiguously. Data structure and value change depending on the destination data type.

Select this command

PLC2 Unprotected Read

PLC2 Unprotected Write


The PLC-2 message types are designed for PLC-2 processors.

If you want to

read 16-bit words from any area of the PLC-2 data table or the PLC-2 compatibility file of another processor.

write 16-bit words to any area of the PLC-2 data table or the PLC-2 compatibility file of another processor.

The message transfer uses 16-bit words, so make sure the Logix5000 tag appropriately stores the transferred data (typically as an INT array).



167


MSG Configuration

Examples

Message Path

Logix5000

→

Logix5000

→

Logix5000

→

Logix5000

→

Message Path

Logix5000

→

Logix5000

→

Logix5000

→

Logix5000

→

The following examples show source and destination tags and elements for different controller combinations.

For MSG instructions originating from a Logix5000 controller and writing to another controller:

Example Source and Destination

source tag

array_1[0]

destination tag

array_2[0]

You can use an alias tag for the source tag (in originating Logix5000 controller).

You cannot use an alias for the destination tag. The destination must be a base tag.

source tag

array_1[0]

destination element

N7:10

You can use an alias tag for the source tag (in originating Logix5000 controller).

source tag

array_1[0]

destination element

010

For MSG instructions originating from a Logix5000 controller and reading from another controller:

Example Source and Destination

source tag

array_1[0]

destination tag

array_2[0]

You cannot use an alias tag for the source tag. The source must be a base tag.

You can use an alias tag for the destination tag (in originating Logix5000 controller).

source element destination tag

N7:10 array_1[0]

You can use an alias tag for the destination tag (in originating Logix5000 controller). source element destination tag

010 array_1[0]

168




Specify the

Communication Details

To configure a MSG instruction, you specify these details on the

Communication tab.

Specify a path

Specify a Communication Method Or

Module Address

Choose a cache option

Specify a path

The path shows the route that the message takes to get to the destination. It uses either names from the I/O configuration of the controller, numbers that you type, or both.

If

The I/O configuration of the controller has the module that gets the message.

The I/O configuration of the controller has only the local communication module.

The I/O configuration of the controller doesn’t have any of the modules that you need for the message.

Then

Use the Browse button to select the module.

1. Use the Browse button to select the local communication module.

2. Type the rest of the path.

Type the path.



169


Example

The I/O configuration of the controller has the module that gets the message.

Click the Browse button and select the module.

The I/O configuration of the controller has only the local communication module.

Go to the local communication module.

Go out the EtherNet/IP port….

to the address of 10.10.10.10.

Go across the backplane… to the module in slot 0.

The I/O configuration of the controller doesn’t have any of the modules that you need for the message.

Go across the backplane… to the local communication module on slot 1

Go out the ControlNet port….

to node 4

Go across the backplane… to the module in slot 0.

To type a path, use this format: port, next_address, port, next_address, …

170




Where

port next_address

Is

For this network

backplane

DF1 (serial, serial channel 0)

ControlNet

EtherNet/IP

DH+ channel A

DH+ channel B

DF1 channel 1

(serial channel 1) backplane

DF1 (serial)

ControlNet

DH+

EtherNet/IP

Type

1

2

3 slot number of the module station address (0-254) node number (1-99 decimal)

8# followed by the node number (1-77 octal)

For example, to specify the octal node address of 37, type 8#37.

You can specify a module on an EtherNet/IP network using any of these formats:

IP address (for example, 10.10.10.10)

IP address:Port (for example, 10.10.10.10:24)

DNS name (for example, tanks)

DNS name:Port (for example, tanks:24)



171


For Block-transfers Over

This Network

ControlNet universal remote I/O

For Block Transfers

For block transfer messages, add the following modules to the I/O configuration of the controller:

Add These Modules To The I/O Configuration

• local communication module (for example, 1756-CNB module)

• remote adapter module (for example, 1771-ACN module)

• local communication module (for example, 1756-DHRIO module)

• one emote adapter module (for example, 1771-ASB module) for each rack, or portion of a rack, in the chassis

• block-transfer module (optional)

Specify a Communication Method Or Module Address

If The Destination Device Is a Then Select


PLC-5 controller over an

EtherNet/IP network

PLC-5 controller over a

ControlNet network

SLC 5/05 controller

CIP

PLC-5 controller over a DH+ network

SLC controller over a DH+ network

DH+

PLC-3 processor

PLC-2 processor

Use the following table to select a communication method or module address for the message.

And Specify

no other specifications required

Channel:

Source Link:

Channel A or B of the 1756-DHRIO module that is connected to the DH+ network

Link ID assigned to the backplane of the controller in the routing table of the 1756-DHRIO module. (The source node in the routing table is automatically the slot number of the controller.)

Destination Link Link ID of the remote DH+ link where the target device resides

Station address of the target device, in octal Destination Node:

If there is only one DH+ link and you did not use the RSLinx software to configure the DH/RIO module for remote links, specify 0 for both the

Source Link and the Destination Link.

172




If The Destination Device Is a Then Select

Application on a workstation that is receiving an unsolicited message routed over an

EtherNet/IP or ControlNet network through RSLinx

CIP with Source ID

(This lets the application receive data from a controller.) block transfer module over a universal remote I/O network block transfer module over a

ControlNet network

RIO

ControlNet

And Specify

Source Link:

Destination Link:

Remote ID of the topic in RSLinx software

Virtual Link ID set up in RSLinx (0-65535)

Destination Node: Destination ID (0-77 octal) provided by the application to RSLinx. For a DDE topic in RSLinx, use 77.

The slot number of the ControlLogix controller is used as the Source

Node.

Channel: Channel A or B of the 1756-DHRIO module that is connected to the RIO network

Rack Rack number (octal) of the module

Group

Slot

Slot

Group number of the module

Slot number that the module is in

Slot number that the module is in

Choose a cache option

Depending on how you configure a MSG instruction, it may use a connection to send or receive data.

This Type Of Message

CIP data table read or write

PLC2, PLC3, PLC5, or SLC (all types)

CIP generic block-transfer read or write

And This Communication Method Uses A Connection

✓

CIP

CIP with Source ID

DH+

✓ your option

✓

(1)

(1)

You can connect CIP generic messages. But for most applications we recommend you leave CIP generic messages unconnected.

If a MSG instruction uses a connection, you have the option to leave the connection open (cache) or close the connection when the message is done transmitting.

If You

Cache the connection

Do not cache the connection

Then

The connection stays open after the MSG instruction is done.

This optimizes execution time. Opening a connection each time the message executes increases execution time.

The connection closes after the MSG instruction is done. This frees up that connection for other uses.



173


IF THE MSG Instructions Are To

different devices same device

The controller has the following limits on the number of connections that you can cache:

If You Have This Software

And Firmware Revision

11.x or earlier

12.x or later

Then You Can Cache

• block transfer messages for up to 16 connections

• other types of messages for up to 16 connections up to 32 connections

If several messages go to the same device, the messages may be able to share a connection.

And They Are

enabled at the same time

NOT enabled at the same time

Then

Each MSG instruction uses 1 connection.

Each MSG instruction uses 1 connection.

The MSG instructions share the connection.

(that is, Together they count as 1 connection.)

EXAMPLE

Share a Connection

If the controller alternates between sending a block-transfer read message and a block-transfer write message to the same module, then together both messages count as 1 connection.

Caching both messages counts as 1 on the cache list.

174




Guidelines

As you plan and program your MSG instructions, follow these guidelines:

Guideline

1. For each MSG instruction, create a control tag.

Details

Each MSG instruction requires its own control tag.

•

Data type = MESSAGE

•

Scope = controller

•

The tag cannot be part of an array or a user-defined data type.

A MSG instruction can access only tags that are in the Controller Tags folder (controller scope).

2. Keep the source and/or destination data at the controller scope.

3. If your MSG is to a device that uses 16-bit integers, use a buffer of INTs in the MSG and DINTs throughout the project.

4. Cache the connected MSGs that execute most frequently.

5. If you want to enable more than 16 MSGs at one time, use some type of management strategy.

6. Keep the number of unconnected and uncached MSGs less than the number of unconnected buffers.

If your message is to a device that uses 16-bit integers, such as a PLC-5® or SLC 500™ controller, and it transfers integers (not REALs), use a buffer of INTs in the message and

DINTs throughout the project.

This increases the efficiency of your project because Logix controllers execute more efficiently and use less memory when working with 32-bit integers (DINTs).

To convert between INTs and DINTs, see Logix5000 Controllers Common Procedures, publication 1756-PM001.

Cache the connection for those MSG instructions that execute most frequently, up to the maximum number permissible for your controller revision.

This optimizes execution time because the controller does not have to open a connection each time the message executes.

If you enable more than 16 MSGs at one time, some MSG instructions may experience delays in entering the queue. To guarantee the execution of each message, use one of these options:

•

Enable each message in sequence.

•

Enable the messages in groups.

•

Program a message to communicate with multiple devices. For more information, see Logix5000 Controllers Common Procedures, publication 1756-PM001.

•

Program logic to coordinate the execution of messages. For more information, see

Logix5000 Controllers Common Procedures, publication 1756-PM001.

The controller can have 10 - 40 unconnected buffers. The default number is 10.

•

If all the unconnected buffers are in use when an instruction leaves the message queue, the instruction errors and does not transfer the data.

•

You can increase the number of unconnected buffers (40 max.), but continue to follow guideline 5 .

•

To increase the number of unconnected buffers, see Logix5000 Controllers Common

Procedures, publication 1756-PM001.



175


Get System Value (GSV) and

Set System Value (SSV)

The GSV/SSV instructions get and set controller system data that is stored in objects.

Operands:

Relay Ladder

Operand

Class name

Instance name

Attribute Name

Destination (GSV)

Type

Source (SSV)

SINT

INT

DINT

REAL structure

SINT

INT

DINT

REAL structure

176

Format

name name name tag tag

Description

name of object name of specific object, when object requires name attribute of object data type depends on the attribute you select destination for attribute data tag that contains data you want to copy to the attribute

Structured Text

GSV(ClassName,InstanceName,AttributeName,Dest);

SSV(ClassName,InstanceName,AttributeName,Source);

The operands for are the same as those for the relay ladder GSV and SSV instructions.




Description:

The GSV/SSV instructions get and set controller system data that is stored in objects. The controller stores system data in objects. There is no status file, as in the PLC-5 processor.

When enabled, the GSV instruction retrieves the specified information and places it in the destination. When enabled, the SSV instruction sets the specified attribute with data from the source.

When you enter a GSV/SSV instruction, the programming software displays the valid object classes, object names, and attribute names for each instruction.

For the GSV instruction, you can get values for all the available attributes. For the SSV instruction, the software displays only those attributes are allowed to set (SSV).

ATTENTION

Use the GSV and SSV instructions carefully. Making changes to objects may cause unexpected controller operation or injury to personnel.

You must test and confirm that the instructions don’t change data that you don’t want them to change.

The GSV and SSV instructions write or read past a member into other members of a tag. If the tag is too small, the instructions don’t write or read the data. They log a minor fault instead.

Example 1

Member_A is too small for the attribute. So the GSV instruction writes the last value to Member_B.

Example 2

My_Tag is too small for the attribute. So the GSV instruction stops and logs a minor fault.

The GSV/SSV Objects section shows each object’s attributes and their associated data types. For example, the MajorFaultRecord attribute of the

Program object needs a DINT[11] data type.



177



not affected


Condition


EnableIn is set

A Minor Fault Will Occur If Fault Type

invalid object address specified an object that does not support

GSV/SSV invalid attribute did not supply enough information for an SSV instruction the GSV destination was not large enough to hold the requested data

4

4

4

4

4

Execution:






na


No action taken na na instruction executes postscan

Get or set the specified value.




Get or set the specified value.

No action taken.

6

6

Fault Code

5

6

7

178



GSV/SSV Objects


When you enter a GSV/SSV instruction, you specify the object and its attribute that you want to access. In some cases, there will be more than one instance of the same type of object, so you might also have to specify the object name. For example, there can be several tasks in your application. Each task has its own TASK object that you access by the task name.

ATTENTION

For the GSV instruction, only the specified size of data is copied to the destination. For example, if the attribute is specified as a

SINT and the destination is a DINT, only the lower 8 bits of the

DINT destination are updated, leaving the remaining 24 bits unchanged.

You can access these objects:

For Information About This Object

AXIS

CONTROLLER

CONTROLLERDEVICE

CST

DF1

FAULTLOG

MESSAGE

MODULE

MOTIONGROUP

PROGRAM

ROUTINE

SERIALPORT

TASK

WALLCLOCKTIME

187

188

190

191

192

193

193

195

197

180

181

183

184

See This Page Or Publication

ControlLogix Motion Module Setup and

Configuration Manual, publication

1756-UM006



179


Access the CONTROLLER object

Attribute

TimeSlice

ControllerLogTotalEntryCou nt

DINT

ControllerLogExecutionMod ificationCount

DINT

ControllerLogUnsavedEntry

Count

DINT

ControllerLogAutoWrite

Data Type

INT

BOOL

ExecutionCountConfigureM ask

DINT

The CONTROLLER object provides status information about a controller’s execution.

Instruction

GSV

SSV

SSV

GSV

SSV

GSV

GSV

MSG

MSG

Description

Percentage of available CPU that is assigned to communications.

Valid values are 10-90. This value cannot be changed when the controller keyswitch is in the run position.

Number of controller log entries since the last firmware upgrade.

The number will be reset if RAM enters a bad state.

The number is capped at the largest DINT.

Number of controller log entries that originated from a program/task properties change, an online edit, or a controller timeslice change. It can also be configured to include log entries originating from forces.

The number will be reset if RAM enters a bad state.

The number is not capped at the largest DINT, and a rollover can occur.

Number of entries in the controller log that have yet to be stored to removable media.

Range from 0 to maximum number of entries.

Flag used to determine if the automatic write of the controller log to removable media is enabled.

0 = auto write is disabled (fault).

1 = controller log will attempt to write to removable media when the log is 80% full.

Bit array used to determine what will cause the Modify

Execution Count to increment.

0 = default (everything but forces).

1 = forces included (everything and forces).

180



Attribute

DeviceName

ProductCode

ProductRev

SerialNumber


Access the CONTROLLERDEVICE object

Data Type

SINT[33]

INT

INT

DINT

The CONTROLLERDEVICE object identifies the physical hardware of the controller.

Instruction

GSV

GSV

GSV

GSV

Description

ASCII string that identifies the catalog number of the controller and memory board.

The first byte contains a count of the number of ASCII characters returned in the array string.

Identifies the type of controller

Logix Controller

CompactLogix5320

CompactLogix5330

CompactLogix5335E

ControlLogix5550

ControlLogix5553

ControlLogix5555

ControlLogix5561

ControlLogix5562

ControlLogix5563

DriveLogix5720

FlexLogix5433

FlexLogix5434

SoftLogix5860

41

42

15

54

55

56

48

65

3

50

51

Product Code

43

44

Identifies the current product revision. Display should be hexadecimal.

The low byte contains the major revision; the high byte contains the minor revision.

Serial number of the device.

The serial number is assigned when the device is built.



181


Attribute

Status

Type

Vendor

INT

INT

Data Type

INT

Instruction

GSV

GSV

GSV

0001

0010

0011

0100

Description

Bits identify status:

Bits 3-0 are reserved

Device Status Bits

Bits 7-4:

0000

Meaning:

reserved flash update in progress reserved reserved flash is bad

0101

0110 faulted run

0111

Fault Status Bits

program

Bits 11-8:

0001

Meaning:

recoverable minor fault

0010

0100 unrecoverable minor fault recoverable major fault

1000 unrecoverable major fault

Logix5000 Specific Status Bits

Bits 13-12:

01

10

Meaning:

keyswitch in run keyswitch in program

11

Bits 15-14

01 keyswitch in remote

Meaning

controller is changing modes

10 debug mode if controller is in run mode

Identifies the device as a controller.

Controller = 14

Identifies the vendor of the device.

Allen-Bradley = 0001

182



Attribute

CurrentStatus

CurrentValue


Data Type

INT

DINT[2]

Access the CST object

The CST (coordinated system time) object provides coordinated system time for the devices in one chassis.

Instruction

GSV

GSV

Description

Current status of the coordinated system time. Bits identify:

Bit: Meaning

0

1

2 timer hardware faulted: the device’s internal timer hardware is in a faulted state ramping enabled: the current value of the timer’s lower

16+ bits ramp up to the requested value, rather than snap to the lower value. These bits are manipulated by the network specific tick synchronization method.

system time master: the CST object is a master time source in the ControlLogix system

3

4

5

6 synchronized: the CST object’s 64-bit CurrentValue is synchronized by a master CST object via a system time update local network master: the CST object is the local network master time source in relay mode: the CST object is acting in a time relay mode duplicate master detected: a duplicate local network time master has been detected. This bit is always 0 for time-dependent nodes.

7

8-9 unused

00 = time dependent node

01 = time master node

10 = time relay node

11 = unused

10-15 unused

Current value of the timer. DINT[0] contains the lower 32; DINT[1] contains the upper 32 bits.

The timer source is adjusted to match the value supplied in update services and from local communication network synchronization. The adjustment is either a ramping to the requested value or an immediate setting to the request value, as reported in the

CurrentStatus attribute.



183


Access the DF1 object

The DF1 object provides an interface to the DF1 communication driver that you can configure for the serial port.

Attribute

ACKTimeout

EmbeddedResponseEnable

ENQTransmitLimit

EOTSuppression

Data Type

DINT

SINT

SINT

SINT

Instruction

GSV

GSV

GSV

GSV

Description

The amount of time to wait for an acknowledgment to a message transmission (point-to-point and master only).

DiagnosticCounters

word offset

0

1

2

5

6

3

4

11

12

13

14

7

8

9

10

15

16

17

18

DuplicateDetection

INT[19]

DF1 point-to-point

signature (0x0043) modem bits packets sent packets received undelivered packets unused

NAKs received

ENQs received bad packets NAKed no memory sent NAK duplicate packets received bad characters received

DCD recoveries count lost modem count unused unused unused unused

ENQs sent

SINT

GSV

Valid value 0-32,767. Delay in counts of 20 msec periods. Default is 50 (1 second).

Array of diagnostic counters for the DF1 communication driver.

GSV

DF1 slave

signature (0x0042) modem bits packets sent packets received undelivered packets messages retried

NAKs received poll packets received bad packets not ACKed no memory not ACKed duplicate packets received unused

DCD recoveries count lost modem count unused unused unused unused unused

Enables duplicate message detection.

master

signature (0x0044) modem bits packets sent packets received undelivered packets messages retried unused unused bad packets not ACKed unused duplicate packets received unused

DCD recoveries count lost modem count priority scan time maximum priority scan time last normal scan time maximum normal scant time last unused

Value:

0 non zero

Meaning:

duplicate message detection disabled duplicate message detection disabled

Enables embedded response functionality (point-to-point only).

Value:

0

1

Meaning:

initiated only after one is received (default) enabled unconditionally

The number of inquiries (ENQs) to send after an ACK timeout

(point-to-point only).

Valid value 0-127. Default setting is 3.

Enable suppressing EOT transmissions in response to poll packets

(slave only).

Value:

0 non zero

Meaning:

EOT suppression disabled (disabled)

EOT suppression enabled

184




Attribute

ErrorDetection

MasterMessageTransmit

Data Type

SINT

Instruction

GSV

SINT GSV

Description

Specifies the error-detection scheme.

Value:

0

1

Meaning:

BCC (default)

CRC

Current value of the master message transmission (master only).

NAKReceiveLimit SINT GSV

NormalPollGroupSize

PollingMode

ReplyMessageWait

StationAddress

SlavePollTimeout

TransmitRetries

INT

SINT

DINT

INT

DINT

SINT

GSV

GSV

GSV

GSV

GSV

GSV

Valid value 0-127. Default is 3.

Number of stations to poll in the normal poll node array after polling all the stations in the priority poll node array (master only).

1

2

3


Current polling mode (master only).

Value:

0

Meaning:

message-based, but don’t allow slaves to initiate messages message-based, but allow slaves to initiate messages (default) standard, single-message transfer per node scan standard, multiple-message transfer per node scan

Default setting is 1.

The time (acting as a master) to wait after receiving an ACK before polling the slave for a response (master only).

Valid value 0-65,535. Delay in counts of 20 msec periods. The default is 5 periods (100 msec).

Current station address of the serial port.


The amount of time in msecs that the slave waits for the master to poll before the slave declares that it is unable to transmit because the master is inactive (slave only).

Valid value 0-32,767. Delay in counts of 20 msec periods. The default is 3000 periods (1 minute).

Number of times to resend a message without getting an acknowledgment (master and slave only).


Pending value for the ACKTimeout attribute.

PendingACKTimeout DINT SSV



185


Attribute

PendingDuplicateDetection

PendingEmbeddedResponse

Enable

PendingENQTransmitLimit

PendingEOTSuppression

PendingErrorDetection

Data Type

SINT

SINT

SINT

SINT

SINT

PendingNormalPollGroupSize INT

PendingMasterMessage

Transmit

SINT

PendingNAKReceiveLimit SINT

PendingPollingMode

PendingReplyMessageWait

PendingStationAddress

PendingSlavePollTimeout

PendingTransmitRetries

SINT

DINT

INT

DINT

SINT

Instruction

SSV

SSV

SSV

SSV

SSV

SSV

SSV

Description

Pending value for the DuplicateDetection attribute.

Pending value for the EmbeddedResponse attribute.

Pending value for the ENQTransmitLimit attribute.

Pending value for the EOTSuppression attribute.

Pending value for the ErrorDetection attribute.

Pending value for the NormalPollGroupSize attribute.

Pending value for the MasterMessageTransmit attribute.

SSV

SSV

SSV

SSV

SSV

SSV

Pending value for the NAKReceiveLimit attribute.

Pending value for the PollingMode attribute.

Pending value for the ReplyMessageWait attribute.

Pending value for the StationAddress attribute.

Pending value for the SlavePollTimeout attribute.

Pending value for the TransmitRetries attribute.

To apply values for any of the DF1 pending attributes:

1.

Use an SSV instruction to set the value for the pending attribute.

You can set as many pending attributes as you want, using an SSV instruction for each pending attribute.

2.

Use a MSG instruction to apply the value. The MSG instruction applies every pending attribute you set. Configure the MSG instruction as:

MSG Configuration Tab

Configuration

Communication

Field

Message Type

Service Code

Object Type

Object ID

Object Attribute

Source

Number of Elements

Destination

Path

Value

CIP Generic

0d hex a2

1 leave blank leave blank

0 leave blank

communication path to self

(1,s where s = slot number of controller)

186



Attribute

MajorEvents

MinorEvents

MajorFaultBits

MinorFaultBits


Access the FAULTLOG object

Data Type

INT

INT

DINT

DINT

The FAULTLOG object provides fault information about the controller.

Instruction

GSV

SSV

GSV

SSV

GSV

SSV

GSV

SSV

Description

How many major faults have occurred since the last time this counter was reset.

How many minor faults have occurred since the last time this counter was reset.

Individual bits indicate the reason for the current major fault.

6

9

Bit:

4

10

6

7

4

5

Bit:

1

3

8

11

Meaning:

power loss

I/O instruction execution (program) fault handler watchdog stack mode change motion

Individual bits indicate the reason for the current minor fault.

Meaning:

instruction execution (program) watchdog serial port battery



187


Attribute

ConnectionPath

ConnectionRate

MessageType

Port

TimeoutMultiplier

UnconnectedTimeout

Access The MESSAGE Object

Data Type

SINT[130]

DINT

SINT

SINT

SINT

DINT

You can access the MESSAGE object through the GSV/SSV instructions.

Specify the message tag name to determine which MESSAGE object you want. The MESSAGE object provides an interface to setup and trigger peer-to-peer communications. This object replaces the MG data type of the

PLC-5 processor.

Instruction

GSV

SSV

GSV

SSV

GSV

SSV

Description

Data to setup the connection path. The first two bytes (low byte and high byte) are the length in bytes of the connection path.

Requested packet rate of the connection.

GSV

SSV

GSV

SSV

Specifies the type of message.

Value:

0

Meaning:

not initialized

Indicates which port the message should be sent on.

Value:

1

2

Meaning:

backplane serial port

Determines when a connection should be considered timed out and closed.

Value:

0

1

2

Meaning:

connection will timeout in 4 times the update rate

(default) connection will timeout in 8 times the update rate connection will timeout in 16 times the update rate

Timeout period in microseconds for all unconnected messages. The default is 30,000,000 microseconds (30 seconds).

GSV

SSV

To change a MESSAGE attribute, follow these steps:

1.

Use a GSV instruction to get the MessageType attribute and save it in a tag.

2.

Use a SSV instruction to set the MessageType to 0.

3.

Use a SSV instruction to set the MESSAGE attribute that you want to change.

4.

Use a SSV instruction to set the MessageType attribute back to the original value you obtained in step 1.

188



0

1

Input/Output Instructions (MSG, GSV, SSV, IOT) Chapter 4 msg_path msg_1.EN

/

Example:

The following example changes the ConnectionPath attribute, so that the message goes to a different controller. When msg_path is on, sets the path of the msg_1 message to the value of msg_1_path. This send the message to a different controller.

Where

msg_1 msg_1_type tag_a msg_1_path

Is

message whose attribute you want to change tag that stores the value of the MessageType attribute tag that stores a 0.

array tag that stores the new connection path for the message

Relay Ladder

GSV

Get System Value

Class name

Instance name

MESSAGE msg_1

Dest msg_1_type

2

SSV

Set System Value

Class name MESSAGE

Instance name msg_1

Source msg_1_path[0]

6

Set System Value

Class name

Instance name

Source

Class name

Source

SSV

SSV

Set System Value

Instance name

MESSAGE msg_1 tag_a

MESSAGE msg_1

Attribute Na MessageType msg_1_type

2

MSG

Type - CIP Data Table Write

Message Control msg_1 ...

EN

DN

ER

0

Structured Text

IF msg_path THEN

GSV(MESSAGE,msg_1,MessageType,msg_1_type);

SSV(MESSAGE,msg_1,MessageType,tag_a);

SSV(MESSAGE,msg_1,ConnectionPath,msg_1_path[0]);

SSV(MESSAGE,msg_1,MessageType,msg_1_type);

END_IF;

IF NOT msg_1.EN THEN

MSG(msg_1);

END_IF;



189


Attribute

EntryStatus

FaultCode

FaultInfo

ForceStatus

Data Type

INT

INT

DINT

INT

Access The MODULE Object

The MODULE object provides status information about a module. To select a particular MODULE object, set the Object Name operand of the GSV/SSV instruction to the module name, The specified module must be present in the

I/O Configuration section of the controller organizer and must have a device name.

Instruction

GSV

GSV

GSV

GSV

Description

Specifies the current state of the specified map entry. The lower 12 bits should be masked when performing a comparison operation. Only bits

12-15 are valid.

Value:

16#0000

16#1000

Meaning:

Standby: the controller is powering up.

Faulted: any of the MODULE object’s connections to the associated module fail. This value should not be used to determine if the module failed because the

MODULE object leaves this state periodically when trying to reconnect to the module. Instead, test for

Running state (16#4000). Check for FaultCode not equal to 0 to determine if a module is faulted.

When Faulted, the FaultCode and FaultInfo attributes are valid until the fault condition is corrected.

16#2000

16#3000

16#4000

16#5000

16#6000

Validating: the MODULE object is verifying MODULE object integrity prior to establishing connections to the module.

Connecting: the MODULE object is initiating connections to the module.

Running: all connections to the module are established and data is successfully transferring.

Shutting down: the MODULE object is in the process of shutting down all connections to the module.

Inhibited: the MODULE object is inhibited (the inhibit bit in the Mode attribute is set).

16#7000 Waiting: the parent MODULE object upon which this MODULE object depends is not running.

A number which identifies a module fault, if one occurs.

Provides specific information about the MODULE object fault code.

Specifies the status of forces.

Bit:

0

1

2-15

Meaning:

forces installed (1=yes, 0-no) forces enabled (1=yes, 0=no) not used

190



Attribute

Instance

LEDStatus

Mode

Attribute

Instance


Data Type

DINT

INT

INT

Instruction

GSV

GSV

GSV

SSV

Description

Provides the instance number of this MODULE object.

Specifies the current state of the I/O LED on the front of the controller.

Value:

0

Meaning:

LED off: No MODULE objects are configured for the controller (there are no modules in the I/O Configuration section of the controller organizer).

1

2

2

Flashing red: None of the MODULE objects are Running.

Flashing green: At least one MODULE object is not Running.

Solid green: All the Module objects are Running.

3

Note: You do not enter an object name with this attribute because this attribute applies to the entire collection of modules.

Specifies the current mode of the MODULE object.

Bit:

0

Meaning:

If set, causes a major fault to be generated if any of the

MODULE object connections fault while the controller is in Run mode.

If set, causes the MODULE object to enter Inhibited state after shutting down all the connections to the module.

Data Type

DINT

Access The MOTIONGROUP Object

The MOTIONGROUP object provides status information about a group of axes for the servo module. Specify the motion-group tag name to determine which MOTIONGROUP object you want.

Instruction

GSV

Description

Provides the instance number of this MOTION_GROUP object.



191


Attribute

DisableFlag

Instance

LastScanTime

MajorFaultRecord

Name:

TimeLow

TimeHigh

Type

Code

Info

SFCRestart

Name:

TimeLow

TimeHigh

Type

Code

Info

MaxScanTime

MinorFaultRecord

192

Access The PROGRAM Object

Data Type

SINT

DINT

DINT

DINT[11]

Data Type:

DINT

DINT

INT

INT

DINT[8]

DINT

DINT[11]

Data Type:

DINT

DINT

INT

INT

DINT[8]

INT

GSV

GSV

SSV

GSV

SSV

Style:

Decimal

Decimal

Decimal

Decimal

Hexadecimal

GSV

SSV

GSV

SSV

The PROGRAM object provides status information about a program. Specify the program name to determine which PROGRAM object you want.

Instruction

GSV

SSV

Style:

Decimal

Decimal

Decimal

Decimal

Hexadecimal

GSV

SSV

Description

Controls this program’s execution.

Value:

0

1

Meaning:

execution enabled execution disabled

Provides the instance number of this PROGRAM object.

Time it took to execute this program the last time it was executed.

Time is in microseconds.

Records major faults for this program

We recommend that you create a user-defined structure to simplify access to the MajorFaultRecord attribute:

Description:

lower 32 bits of fault timestamp value upper 32 bits of fault timestamp value fault type (program, I/O, etc.) unique code for the fault (depends on fault type) fault specific information (depends on fault type and code)

Maximum recorded execution time for this program. Time is in microseconds.

Records minor faults for this program

We recommend that you create a user-defined structure to simplify access to the MinorFaultRecord attribute:

Description:

lower 32 bits of fault timestamp value upper 32 bits of fault timestamp value fault type (program, I/O, etc.) unique code for the fault (depends on fault type) fault specific information (depends on fault type and code) unused - reserved for future use



Attribute

Instance


Data Type

DINT

Access The Routine object

The ROUTINE object provides status information about a routine. Specify the routine name to determine which ROUTINE object you want.

Instruction

GSV

Description

Provides the instance number of this ROUTINE object.

Valid values are 0-65,535.

Attribute

BaudRate

DataBits

Parity

RTSOffDelay

RTSSendDelay

StopBits

Data Type

DINT

SINT

SINT

INT

INT

SINT

DINT

Access The SERIALPORT Object

The SERIALPORT object provides an interface to the serial communication port.

Instruction

GSV

GSV

GSV

GSV

GSV

GSV

SSV

Description

Specifies the baud rate.

Valid values are 110, 300, 600, 1200, 2400, 4800, 9600, and

19200 (default).

Specifies the number of bits of data per character.

Value:

7

8

Meaning:

7 data bits (ASCII only)

8 data bits (default)

Specifies the parity.

1

2

Value:

0

Meaning:

no parity (no default) odd parity (ASCII only) even parity

Amount of time to delay turning off the RTS line after the last character has been transmitted.

Valid value 0-32,767. Delay in counts of 20 msec periods. The default is 0 msec.

Amount of time to delay transmitting the first character of a message after turning on the RTS line.

Valid value 0-32,767. Delay in counts of 20 msec periods. The default is 0 msec.

Specifies the number of stop bits.

Value:

1

2

Meaning:

1 stop bit (default)

2 stop bits (ASCII only)

Pending value for the BaudRate attribute.

PendingBaudRate



193


Attribute

PendingDataBits

PendingParity

PendingRTSOffDelay

PendingRTSSendDelay

PendingStopBits

Data Type

SINT

SINT

INT

INT

SINT

Instruction

SSV

SSV

SSV

SSV

SSV

Description

Pending value for the DataBits attribute.

Pending value for the Parity attribute.

Pending value for the RTSOffDelay attribute.

Pending value for the RTSSendDelay attribute.

Pending value for the StopBits attribute.

To apply values for any of the SERIALPORT pending attributes:

1.

Use an SSV instruction to set the value for the pending attribute.

You can set as many pending attributes as you want, using an SSV instruction for each pending attribute.

2.

Use a MSG instruction to apply the value. The MSG instruction applies every pending attribute you set. Configure the MSG instructions as:

MSG Configuration Tab

Configuration

Communication

Field

Message Type

Service Code

Object Type

Object ID

Object Attribute

Source

Number of Elements

Destination

Path

Value

CIP Generic

0 d hex

6f hex

1 leave blank leave blank

0 leave blank communication path to self

(1,s where s = slot number of controller)

194




Attribute

DisableUpdateOutputs

EnableTimeOut

InhibitTask

Instance

LastScanTime

MaxInterval

MaxScanTime

MinInterval

OverlapCount

Data Type

DINT

DINT

DINT

DINT

DINT

DINT[2]

DINT

DINT[2]

DINT

Access The TASK Object

The TASK object provides status information about a task. Specify the task name to determine which TASK object you want.

Instruction

GSV

SSV

GSV

SSV

GSV

SSV

GSV

GSV

SSV

GSV

SSV

GSV

SSV

GSV

SSV

GSV

SSV

Description

Enables or disables the processing of outputs at the end of a task

To: Set the attribute to:

enable the processing of outputs at the end of the task

0 disable the processing of outputs at the end of the task

1 (or any non-zero value)

Enables or disables the timeout function of an event task.


disable the timeout function enable the timeout function

0


Prevents the task from executing. If a task is inhibited, the controller still prescans the task when the controller transitions from program to run or test mode.


enable the task inhibit (disable) the task

0 (default)


Provides the instance number of this TASK object.

Valid values are 0-31.

Time it took to execute this task the last time it was executed. Time is in microseconds.

The maximum time interval between successive executions of the task. DINT[0] contains the lower 32 bits of the value; DINT[1] contains the upper 32 bits of the value.

A value of 0 indicates 1 or less executions of the task.

Maximum recorded execution time for this program. Time is in microseconds.

The minimum time interval between successive executions of the task. DINT[0] contains the lower 32 bits of the value; DINT[1] contains the upper 32 bits of the value.

A value of 0 indicates 1 or less executions of the task.

Number of times that the task was triggered while it was still executing. Valid for an event or a periodic task.

To clear the count, set the attribute to 0.



195


Attribute

Priority

Rate

StartTime

Status

Watchdog

Data Type

INT

DINT

DINT[2]

DINT

DINT

GSV

SSV

GSV

SSV

Instruction

GSV

SSV

GSV

SSV

GSV

SSV

Description

Relative priority of this task as compared to the other tasks.

Valid values 1...15.

If the task type is:

periodic

Then the Rate attribute specifies the:

Period for the task. Time is in microseconds.

event The timeout value for the task.


Value of WALLCLOCKTIME when the last execution of the task was started. DINT[0] contains the lower 32 bits of the value;

DINT[1] contains the upper 32 bits of the value.

Provides status information about the task. Once the controller sets one of these bits, you must manually clear the bit.

To determine if:

An EVNT instruction triggered the task (event task only).

A timeout triggered the task

(event task only).

An overlap occurred for this task.

Examine this bit:

0

1

2

Time limit for execution of all programs associated with this task.


If you enter 0, these values are assigned:

Time:

0.5 sec

5.0 sec

Task Type:

periodic or event continuous

196



Attribute

CSTOffset

CurrentValue

DateTime


Data Type

DINT[2]

DINT[2]

DINT[7]

Access The WALLCLOCKTIME Object

The WALLCLOCKTIME object provides a timestamp the controller can use for scheduling.

Instruction

GSV

SSV

GSV

SSV

GSV

SSV

Description

Positive offset from the CurrentValue of the CST object (coordinated system time, see page 183 ). DINT[0] contains the lower 32 bits of the value; DINT[1] contains the upper 32 bits of the value.

Value in

μ secs. The default is 0.

Current value of the wall clock time. DINT[0] contains the lower 32 bits of the value; DINT[1] contains the upper 32 bits of the value.

The value is the number of microseconds that have elapsed since

0000 hrs 1 January 1972.

The CST and WALLCLOCKTIME objects are mathematically related in the controller. For example, if you add the CST CurrentValue and the WALLCLOCKTIME CTSOffset, the result is the WALLCLOCKTIME

CurrentValue.

The date and time in a readable format.

DINT[0] year

DINT[1] integer representation of month (1-12)

DINT[2] integer representation of day (1-31)

DINT[3] hour (0-23)

DINT[4] minute (0-59)

DINT[5] seconds (0-59)

DINT[6] microseconds (0-999,999)



197


GSV/SSV Programming

Example

Get Fault Information

The following examples use GSV instructions to get fault information.

Example 1:

This example gets fault information from the I/O module disc_in_2 and places the data in a user-defined structure disc_in_2_info.

Relay Ladder

Structured Text

GSV(MODULE,disc_in_2,FaultCode,disc_in_2_info.FaultCode);

GSV(MODULE,disc_in_2,FaultInfo,disc_in_2_info.FaultInfo);

GSV(MODULE,disc_in_2,Mode,disc_in_2info.Mode);

Example 2:

This example gets status information about program discrete and places the data in a user-defined structure discrete_info.

Relay Ladder

198

Structured Text

GSV(PROGRAM,DISCRETE,LASTSCANTIME, discrete_info.LastScanTime);

GSV(PROGRAM,DISCRETE,MAXSCANTIME,discrete_info.MaxScanTime);




Example 3:

This example gets status information about task IO_test and places the data in a user-defined structure io_test_info.

Relay Ladder

Structured Text

GSV(TASK,IO_TEST,LASTSCANTIME,io_test_info.LastScanTime);

GSV(TASK,IO_TEST,MAXSCANTIME,io_test_info.MaxScanTime);

GSV(TASK,IO_TEST,WATCHDOG,io_test_info.WatchDog);



199


Set Enable And Disable Flags

The following example uses the SSV instruction to enable or disable a program. You could also use this method to enable or disable an I/O module, which is a similar to using inhibit bits with a PLC-5 processor.

Example:

Based on the status of SW.1, place the appropriate value in the disableflag attribute of program discrete.

Relay Ladder

Structured Text

IF SW.1 THEN discrete_prog_flag := enable_prog;

ELSE discrete_prog_flag := disable_prog;

END_IF;

SSV(PROGRAM,DISCRETE,DISABLEFLAG,discrete_prog_flag);

200




Immediate Output (IOT)

The IOT instruction immediately updates the specified output data (output tag or produced tag).

Operands:

Relay Ladder

Operand

Update Tag

Type Format

tag

Description

tag that you want to update, either:

• output tag of an I/O module

• produced tag

Do not choose a member or element of a tag.

For example, Local:5:0 is OK but

Local:5:0.Data is not OK.

IOT(output_tag);

Structured Text

The operands are the same as those for the relay ladder IOT instruction.

Description:

The IOT instruction overrides the requested packet interval (RPI) of an output connection and sends fresh data over the connection.

•

An output connection is a connection that is associated with the output tag of an I/O module or with a produced tag.

•

If the connection is for a produced tag, the IOT instruction also sends the event trigger to the consuming controller. This lets the IOT instruction trigger an event task in the consuming controller.

To use an IOT instruction and a produced tag to trigger an event task in a consumer controller, configure the produced tag as follows:

Check this box.

This configures the tag to update its event trigger only via an IOT instruction.



201


With This Controller

ControlLogix

SoftLogix5800

EtherNet/IP network

values loaded into produced tag

IOT instruction in the producing controller event task in the consuming controller

The type of network between the controllers determines when the consuming controller receives the new data and event trigger via the IOT instruction.

Over This Network

backplane

EtherNet/IP network

ControlNet network

You can produce and consume tags only over a ControlNet network.

The Consuming Device Receives The

Data And Event Trigger

immediately immediately within the actual packet interval (API) of the consumed tag (connection) within the actual packet interval (API) of the consumed tag (connection)

The following diagrams compare the receipt of data via an IOT instruction over EtherNet/IP and ControlNet networks.

ControlNet network

values loaded into produced tag

IOT instruction in the producing controller

RPI of the produced tag event task in the consuming controller


not affected


none

202




Execution:

Condition


EnableIn is set






na instruction execution postscan


No action taken.

na na



The instruction:

• updates the connection of the specified tag.

• resets the RPI timer of the connection


No action taken.

Example 1:

When the IOT instruction executes, it immediately sends the values of the

Local:5:0 tag to the output module.

Relay Ladder

Structured Text

IOT (Local:5:O);



203


Example 2:

This controller controls station 24 and produces data for the next station

(station 25). To use an IOT instruction to signal the transmission of new data, the produced tag is configured as follows:

Produced_Tag is configured to update its event trigger via an IOT instruction.

Relay Ladder

If New_Data = on, then the following occurs for one scan:

The CPS instruction sets Produced_Tag = Source_Tag.

The IOT instruction updates Produced_Tag and sends this update to the consuming controller (station 25). When the consuming controller receives this update, it triggers the associated event task in that controller.

Structured Text

IF New_Data AND NOT Trigger_Consumer THEN

CPS (Source_Tag,Produced_Tag,1);

IOT (Produced_Tag);

END_IF;

Trigger_Consumer := New_Data;

204



Chapter

5

Compare Instructions

(CMP, EQU, GEQ, GRT, LEQ, LES, LIM, MEQ, NEQ)

Introduction

If You Want To

compare values based on an expression test whether two values are equal test whether one value is greater than or equal to a second value test whether one value is greater than a second value test whether one value is less than or equal to a second value test whether one value is less than a second value test whether one value is between two other values pass two values through a mask and test whether they are equal test whether one value is not equal to a second value

The compare instructions let you compare values by using an expression or a specific compare instruction.

Use This Instruction Available In These Languages See Page

CMP 206

EQU relay ladder structured text


(2) function block

211

GEQ

GRT

LEQ

LES

LIM

MEQ

NEQ relay ladder structured text

(1) function block relay ladder structured text






(1) function block

215

219

223

227

231

237

242

(1)


(2)

There is no equivalent structured text instruction. Use the operator in an expression.

You can compare values of different data types, such as floating point and integer.

For relay ladder instructions, bold data types indicate optimal data types. An instruction executes faster and requires less memory if all the operands of the instruction use the same optimal data type, typically DINT or REAL.



205

Chapter 5 Compare Instructions (CMP, EQU, GEQ, GRT, LEQ, LES, LIM, MEQ, NEQ)

Compare (CMP)

The CMP instruction performs a comparison on the arithmetic operations you specify in the expression.

Operands:

Relay Ladder

Operand Type

Expression SINT

INT

DINT

Format

immediate tag

Description

an expression consisting of tags and/or immediate values separated by operators

REAL string

A SINT or INT tag converts to a DINT value by sign-extension.

Structured Text

Structured text does not have a CMP instruction, but you can achieve the same results using an IF...THEN construct and expression.

IF BOOL_expression THEN

<statement>;

END_IF;

See Appendix C, Structured Text Programming for information on the syntax of constructs and expressions within structured text.

Description:

Define the CMP expression using operators, tags, and immediate values. Use parentheses ( ) to define sections of more complex expressions.

The execution of a CMP instruction is slightly slower and uses more memory than the execution of the other comparison instructions. The advantage of the

CMP instruction is that it allows you to enter complex expressions in one instruction.


The CMP instruction only affects the arithmetic status flags if the expression contains an operator (for example, +,

−

, *, /) that affects the arithmetic status flags.


none

206



Compare Instructions (CMP, EQU, GEQ, GRT, LEQ, LES, LIM, MEQ, NEQ) Chapter 5

Condition


Execution:




postscan evaluate expression expression is true rung-condition-out is set to true expression is false rung-condition-out is set to false end


Examples:

If the CMP instruction finds the expression true, the rung-condition-out is set to true.

If you enter an expression without a comparison operator, such as value_1 +

value_2, or value_1, the instruction evaluates the expression as:

If The Expression

non zero zero

The Rung-condition-out Is Set To

true false



207


CMP expressions

You program expressions in CMP instructions the same as expressions in FSC instructions. Use the following sections for information on valid operators, format, and order of operation, which are common to both instructions.

ABS

ACS

AND

ASN

>

>=

<>

**

ATN

COS

/

=

<

<=

-

*

Operator:

+

Valid operators

Description

add subtract/negate multiply divide equal less than less than or equal

Optimal

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL greater than DINT, REAL greater than or equal DINT, REAL not equal exponent (x to y)

DINT, REAL

DINT, REAL absolute value arc cosine bitwise AND arc sine arc tangent cosine

DINT, REAL

REAL

DINT

REAL

REAL

REAL

SQR

TAN

TOD

TRN

XOR

NOT

OR

RAD

SIN

Operator:

DEG

FRD

LN

LOG

MOD

Description

radians to degrees

BCD to integer natural log log base 10 modulo-divide

Optimal

DINT, REAL

DINT

REAL

REAL

DINT, REAL bitwise complement DINT bitwise OR DINT degrees to radians sine

DINT, REAL

REAL square root tangent integer to BCD truncate

DINT, REAL

REAL

DINT

DINT, REAL bitwise exclusive OR DINT

208




Format Expressions

For each operator that you use in an expression, you have to provide one or two operands (tags or immediate values). Use the following table to format operators and operands within an expression:

For Operators That

Operate On

one operand two operands

Use This Format Examples

operator(operand) ABS(tag_a) operand_a operator operand_b

•

tag_b + 5

•

tag_c AND tag_d

•

(tag_e ** 2) MOD (tag_f /

tag_g)

Determine The Order of Operation

6.

7.

8.

9.

10.

3.

4.

5.

The operations you write into the expression are performed by the instruction in a prescribed order, not necessarily the order you write them. You can override the order of operation by grouping terms within parentheses, forcing the instruction to perform an operation within the parentheses ahead of other operations.

Operations of equal order are performed from left to right.

Order

1.

2.

Operation

( )

ABS, ACS, ASN, ATN, COS, DEG, FRD, LN, LOG,

RAD, SIN, SQR, TAN, TOD, TRN

**

−

(negate), NOT

*, /, MOD

<, <=, >, >=, =

−

(subtract), +

AND

XOR

OR



209


Use Strings In an Expression

Use a relay ladder or structured text expression to compare string data types.

To use strings in an expression, follow these guidelines:

•

An expression lets you compare two string tags.

•

You cannot enter ASCII characters directly into the expression.

•

Only the following operators are permitted

>

>=

<>

Operator

=

<

<=

Description

equal less than less than or equal greater than greater than or equal not equal

•

Strings are equal if their characters match.

•

ASCII characters are case sensitive. Upper case “A” ($41) is not equal to lower case “a” ($61).

•

The hexadecimal values of the characters determine if one string is less than or greater than another string. For the hex code of a character, see the back cover of this manual.

•

When the two strings are sorted as in a telephone directory, the order of the strings determines which one is greater. s e r e s l e r a t g r e

AB

B a ab

ASCII Characters Hex Codes

1ab

1b

A

$31$61$62

$31$62

$41

$41$42

$42

$61

$61$62

AB B

210




Equal to (EQU)

The EQU instruction tests whether Source A is equal to Source B.

Operands:

IF sourceA = sourceB THEN

<statements>;

Relay Ladder

Operand

Source A

Source B

Type

SINT

INT

DINT

REAL string

SINT

INT

DINT

REAL string

Format

immediate tag immediate tag

Description

value to test against

Source B value to test against

Source A

•

If you enter a SINT or INT tag, the value converts to a DINT value by sign-extension.

•

REAL values are rarely absolutely equal. If you need to determine the equality of two REAL values, use the LIM instruction.

•

String data types are:

–

default STRING data type

–

any new string data type that you create

•

To test the characters of a string, enter a string tag for both Source A and Source B.

Structured Text

Use the equal sign “

=

” as an operator within an expression. This expression evaluates whether sourceA is equal to sourceB.

See Appendix C, Structured Text Programming for information on the syntax of expressions within structured text.



211


Function Block

Operand

EQU tag

Type

FBD_COMPARE

Format

structure

Description

EQU structure

FBD_COMPARE Structure

Input Parameter

EnableIn

SourceA

SourceB

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

BOOL

Description

Enable input. If cleared, the instruction does not execute and outputs are not updated.

Default is set.

Value to test against SourceB.

Valid = any float

Value to test against SourceA.

Valid = any float

Description


Result of the instruction. This is equivalent to rung-condition-out of the relay ladder

EQU instruction.

Description:

Use the EQU instruction to compare two numbers or two strings of ASCII characters. When you compare strings:

•


•



not affected


none

212




Condition


Execution:

Relay Ladder

Action



postscan

Condition


EnableIn is cleared


Source A = Source B yes no rung-condition-out is set to false rung-condition-out is set to true end


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



213


Example:

If value_1 is equal to value_2, set light_a. If value_1 is not equal to value_2, clear

light_a.

Relay Ladder

Structured Text

light_a := (value_1 = value_2);

Function Block

214




Greater than or Equal to

(GEQ)

Operands:

The GEQ instruction tests whether Source A is greater than or equal to

Source B.

Relay Ladder

IF sourceA >= sourceB THEN

<statements>;

Operand

Source A

Source B

Type

SINT

INT

DINT

REAL string

SINT

INT

DINT

REAL string

Format

immediate tag

Description

value to test against Source B immediate tag value to test against Source A

•


•


–


–


•


Structured Text

Use adjacent greater than and equal signs “>

=

” as an operator within an expression. This expression evaluates whether sourceA is greater than or equal to sourceB.




215


Function Block

Operand

GEQ tag

Type

FBD_COMPARE

Format

structure

Description

GEQ structure


Input Parameter

EnableIn

SourceA

SourceB

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

BOOL

Description


Default is set.


Valid = any float


Valid = any float

Description


Result of the instruction. This is equivalent to rung-condition-out for the relay ladder

GEQ instruction.

Description:

The GEQ instruction tests whether Source A is greater than or equal to

Source B.

When you compare strings:

•


•


B a ab


1ab $31$61$62

1b

A

AB

$31$62

$41

$41$42

$42

$61

$61$62

AB B

216





not affected


none

Execution:

Relay Ladder

Condition


Action



postscan

Condition


EnableIn is cleared


Source A

≥

Source B yes no rung-condition-out is set to false rung-condition-out is set to true end


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



217


Example:

If value_1 is greater than or equal to value_2, set light_b. If value_1 is less than

value_2, clear light_b.

Relay Ladder

Structured Text

light_b := (value_1 >= value_2);

Function Block

218




Greater Than (GRT)

Operands:

The GRT instruction tests whether Source A is greater than Source B.

IF sourceA > sourceB THEN

<statements>;

Relay Ladder

Operand

Source A

Source B

Type

SINT

INT

DINT

REAL string

SINT

INT

DINT

REAL string

Format

immediate tag

Description


•


•


–


–


•


Structured Text

Use the greater than sign “>” as an operator within an expression. This expression evaluates whether sourceA is greater than sourceB.


Function Block

Operand

GRT tag

Type

FBD_COMPARE

Format

structure

Description

GRT structure



219



Input Parameter

EnableIn

SourceA

SourceB

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

BOOL

Description


Default is set.


Valid = any float


Valid = any float

Description



GRT instruction.

Description:

The GRT instruction tests whether Source A is greater than Source B.


•


•


A

AB

B


1ab $31$61$62

1b $31$62 a ab

$41

$41$42

$42

$61

$61$62

AB B


not affected


none

220




Condition


Execution:

Relay Ladder

Action



postscan

Condition


EnableIn is cleared


Source A

>



Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



221


Example:

If value_1 is greater than value_2, set light_1. If value_1 is less than or equal to

value_2, clear light_1.

Relay Ladder

Structured Text

light_1 := (value_1 > value_2);

Function Block

222




Less Than or Equal to (LEQ)

The LEQ instruction tests whether Source A is less than or equal to Source B.

Operands:

Relay Ladder

IF sourceA <= sourceB THEN

<statements>;

Operand

Source A

Source B

Type

SINT

INT

DINT

REAL string

SINT

INT

DINT

REAL string

Format

immediate tag

Description


•


•


–


–


•


Structured Text

Use adjacent less than and equal signs “<

=

“as an operator within an expression. This expression evaluates whether sourceA is less than or equal to

sourceB.




223


Function Block

Operand

LEQ tag

Type

FBD_COMPARE

Format

structure

Description

LEQ structure


Input Parameter

EnableIn

SourceA

SourceB

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

BOOL

Description


Default is set.


Valid = any float


Valid = any float

Description



LEQ instruction.

Description:

The LEQ instruction tests whether Source A is less than or equal to Source B.


•


•

When the two strings are sorted as in a telephone directory, the order of the strings determines which one is greater. s s e l e r t e r e a g r


1ab

1b

A

AB

B

$31$61$62

$31$62

$41

$41$42

$42 a ab

$61

$61$62

AB B

224





not affected


none

Execution:

Relay Ladder

Condition


Action



postscan

Condition


EnableIn is cleared


Source A

≤ yes no rung-condition-out is set to false rung-condition-out is set to true end


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



225


Example:

If value_1 is less than or equal to value_2, set light_2. If value_1 is greater than


Relay Ladder

Structured Text

light_2 := (value_1 <= value_2);

Function Block

226




Less Than (LES)

The LES instruction tests whether Source A is less than Source B.

Operands:

IF sourceA < sourceB THEN

<statements>;

Relay Ladder

Operand

Source A

Source B

Type

SINT

INT

DINT

REAL string

SINT

INT

DINT

REAL string

Format

immediate tag

Description


•


•


–


• any new string data type that you create

•


Structured Text

Use the less than sign “<“as an operator within an expression. This expression evaluates whether sourceA is less than sourceB.


Function Block

Operand

LES tag

Type

FBD_COMPARE

Format

structure

Description

LES structure



227



Input Parameter

EnableIn

SourceA

SourceB

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

BOOL

Description


Default is set.


Valid = any float


Valid = any float

Description



LES instruction.

Description:

The LES instruction tests whether Source A is less than Source B.


•


•


A

AB

B


1ab $31$61$62

1b $31$62 a ab

$41

$41$42

$42

$61

$61$62

AB B


not affected


none

228




Condition


Execution:

Relay Ladder

Action



postscan

Condition:


EnableIn is false

EnableIn is true postscan

Source A

<



Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



229


Example:

If value_1 is less than value_2, set light_3. If value_1 is greater than or equal to


Relay Ladder

Structured Text

light_3 := (value_1 < value_2);

Function Block

230



Limit (LIM)


Operands:

The LIM instruction tests whether the Test value is within the range of the

Low Limit to the High Limit.

Relay Ladder

Operand

Low limit

Test

High limit

Type

SINT

INT

DINT

Format

immediate tag

Description

value of lower limit

REAL


SINT immediate value to test tag INT

DINT

REAL


SINT immediate value of upper limit tag INT

DINT

REAL


Structured Text

Structured text does not have a LIM instruction, but you can achieve the same results using structured text.

IF (LowLimit <= HighLimit AND

(Test >= LowLimit AND Test <= HighLimit)) OR

(LowLimit >= HighLimit AND

(Test <= LowLimit OR Test >= HighLimit)) THEN

<statement>;

END_IF;



231


Function Block

Operand

LIM tag

Type

FBD_LIMIT

Format

structure

Description

LIM structure

FBD_LIMIT Structure

Input Parameter

EnableIn

LowLimit

Test

Data Type

BOOL

REAL

REAL


EnableOut

Dest

HighLimit

Data Type

BOOL

BOOL

REAL

Description


If set, the instruction executes as described under Execution.

Default is set.

Value of lower limit.

Valid = any float

Value to test against limits.

Valid = any float

Description



LIM instruction.

Value of upper limit.

Valid = any float

Description:

The LIM instruction tests whether the Test value is within the range of the

Low Limit to the High Limit.

If Low Limit

≤

High Limit

≥

High Limit

And Test Value Is

equal to or between limits not equal to or outside limits equal to or outside limits not equal to or inside limits

The Rung-condition-out Is

true false true false

Signed integers “roll over” from the maximum positive number to the maximum negative number when the most significant bit is set. For example, in 16-bit integers (INT type), the maximum positive integer is 32,767, which is represented in hexadecimal as 16#7FFF (bits 0 through 14 are all set). If you increment that number by one, the result is 16#8000 (bit 15 is set). For signed integers, hexadecimal 16#8000 is equal to -32,768 decimal. Incrementing from this point on until all 16 bits are set ends up at 16#FFFF, which is equal to -1 decimal.

232




This can be shown as a circular number line (see the following diagrams). The

LIM instruction starts at the Low Limit and increments clockwise until it reaches the High Limit. Any Test value in the clockwise range from the Low

Limit to the High Limit sets the rung-condition-out to true. Any Test value in the clockwise range from the High Limit to the Low Limit sets the rung-condition-out to false.

Low Limit

≤

The instruction is true if the test value is equal to or between the low and high limit

Low Limit

≥

High Limit

The instruction is true if the test value is equal to or outside the low and high limit

0

0

−

1 +1

+1 low limit high limit high limit

−( n+1) +n n = maximum value


not affected


none

−( n+1) +n n = maximum value low limit



233


Condition


Execution:

Relay Ladder

Action



postscan

Condition


EnableIn is cleared

EnableIn is set postscan evaluate limit comparison is true rung-condition-out is set to true comparison is false rung-condition-out is set to false end


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

234




Example 1:

Low Limit

When 0

≤

≤

value

≥

100, set light_1. If value < 0 or value >100, clear light_1.

Relay Ladder

Structured Text

IF (value <= 100 AND(value >= 0 AND value <= 100)) OR

(value >= 100 AND value <= 0 OR value >= 100)) THEN light_1 := 1;

ELSE light_1 := 0;

END_IF;

Function Block



235


Example 2:

Low Limit

≥

High Limit:

When value

≥

0 or value

≤ −

100

, set light_1. If value < 0 or value >

−

100, clear light_1.

Relay Ladder

Structured Text

IF (0 <= -100 AND value >= 0 AND value <= -100)) OR

(0 >= -100 AND(value <= 0 OR value >= -100)) THEN light_1 := 1;

ELSE light_1 := 0;

END_IF;

Function Block

236




Mask Equal to (MEQ)

Operands:

The MEQ instruction passes the Source and Compare values through a Mask and compares the results.

Relay Ladder

Operand

Source

Mask

Compare

Type

SINT

INT

Format

immediate tag

Description

value to test against Compare

DINT

A SINT or INT tag converts to a DINT value by zero-fill.

SINT immediate defines which bits to block or pass

INT tag

DINT


SINT immediate value to test against Source

INT tag

DINT


Structured Text

Structured text does not have an MEQ instruction, but you can achieve the same results using structured text.

IF (Source AND Mask) = (Compare AND Mask) THEN

<statement>;

END_IF;

Function Block

Operand

MEQ tag

Type

FBD_MASK_EQUAL

Format

structure

Description

MEQ structure



237


FBD_MASK_EQUAL Structure

Input Parameter

EnableIn

Source

Mask

Compare

Data Type

BOOL

DINT

DINT

DINT


EnableOut

Dest

Data Type

BOOL

BOOL

Description


If set, the instruction executes as described under Execution.

Default is set.

Value to test against Compare.

Valid = any integer

Defines which bits to block (mask).

Valid = any integer

Compare value.

Valid = any integer

Description



MEQ instruction.

Description:

A “1” in the mask means the data bit is passed. A “0” in the mask means the data bit is blocked. Typically, the Source, Mask, and Compare values are all the same data type.

If you mix integer data types, the instruction fills the upper bits of the smaller integer data types with 0s so that they are the same size as the largest data type.

Entering an Immediate Mask Value

When you enter a mask, the programming software defaults to decimal values.

If you want to enter a mask using another format, precede the value with the correct prefix.

Prefix

16#

8#

2#

Description

hexadecimal for example; 16#0F0F octal for example; 8#16 binary for example; 2#00110011

238





not affected


none

Execution:

Relay Ladder

Condition


Action



postscan

Condition


EnableIn is cleared

EnableIn is set postscan masked source = masked compare yes no rung-condition-out is set to false rung-condition-out is set to true end


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



239


Example 1:

If the masked value_1 is equal to the masked value_2, set light_1. If the masked

value_1 is not equal to the masked value_2, clear light_1. This example shows that the masked values are equal. A 0 in the mask restrains the instruction from comparing that bit (shown by x in the example).

value_1 0 1 0 1 0 1 0 1 1 1 1 1 1 1 1 1 value_2 0 1 0 1 0 1 0 1 1 1 1 1 0 0 0 0

mask_1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 mask_1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0

Masked value_1 0 1 0 1 0 1 0 1 1 1 1 1 x x x x Masked value_2 0 1 0 1 0 1 0 1 1 1 1 1 x x x x

Relay Ladder

Structured Text

light_1 := ((value_1 AND mask_1)=(value_2 AND mask_2));

Function Block

240




Example 2:

If the masked value_1 is equal to the masked value_2, set light_1. If the masked

value_1 is not equal to the masked value_2, clear light_1. This example shows that the masked values are not equal. A 0 in the mask restrains the instruction from comparing that bit (shown by x in the example).

value_1 0 1 0 1 0 1 0 1 1 1 1 1 1 1 1 1 value_2 0 1 0 1 0 1 0 1 1 1 1 1 0 0 0 0

mask_1 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 mask_1 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1

Masked value_1 x x x x x x x x x x x x 1 1 1 1 Masked value_2 x x x x x x x x x x x x 0 0 0 0

Relay Ladder

Structured Text

light_1 := ((value_1 AND mask_1)=(value_2 AND mask_2));

Function Block



241


Not Equal to (NEQ)

Operands:

The NEQ instruction tests whether Source A is not equal to Source B.

IF sourceA <> sourceB THEN

<statements>;

Relay Ladder

Operand

Source A

Source B

Type

SINT

INT

DINT

REAL string

SINT

INT

DINT

REAL string

Format

immediate tag

Description


•


•


–


–


•


Structured Text

Use the less than and greater than signs “<>“ together as an operator within an expression. This expression evaluates whether sourceA is not equal to

sourceB.


242




Function Block

Operand

NEQ tag

Type

FBD_COMPARE

Format

structure

Description

NEQ structure


Input Parameter

EnableIn

SourceA

SourceB

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

BOOL

Description


Default is set.


Valid = any float


Valid = any float

Description



NEQ instruction.

Description:

The NEQ instruction tests whether Source A is not equal to Source B.


•

Strings are not equal if any of their characters do not match.

•


s s l e e r t e r e a g r

B a ab


1ab $31$61$62

1b

A

AB

$31$62

$41

$41$42

$42

$61

$61$62

AB B


not affected


none



243


Condition


Execution:

Relay Ladder

Action



postscan

Condition


EnableIn is cleared


Source A = Source B yes no rung-condition-out is set to false rung-condition-out is set to true end


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

244




Example:

If value_1 is not equal to value_2, set light_4. If value_1 is equal to value_2, clear

light_4.

Relay Ladder

Structured Text

light_4 := (value_1 <> value_2);

Function Block



245


Notes:

246



Chapter

6

Compute/Math Instructions

(CPT, ADD, SUB, MUL, DIV, MOD, SQR, SQRT, NEG, ABS)

Introduction

If You Want To

evaluate an expression add two values subtract two values multiply two values divide two values determine the remainder after one value is divided by another calculate the square root of a value take the opposite sign of a value take the absolute value of a value

The compute/math instructions evaluate arithmetic operations using an expression or a specific arithmetic instruction.


CPT

ADD

SUB

MUL

DIV

MOD

SQR

SQRT

(3)

NEG

ABS








(2) function block relay ladder structured text function block relay ladder structured text

(2) function block relay ladder structured text function block

See Page

248

252

255

258

261

266

270

274

277

(1)


(2)


(3)

Structured text only.

You can mix data types, but loss of accuracy and rounding error might occur and the instruction takes more time to execute. Check the S:V bit to see whether the result was truncated.



247

Chapter 6 Compute/Math Instructions (CPT, ADD, SUB, MUL, DIV, MOD, SQR, SQRT, NEG, ABS)


Compute (CPT)

The CPT instruction performs the arithmetic operations you define in the expression.

Operands:

Relay Ladder

Operand Type

Destination SINT

INT

DINT

REAL

Format:

tag

Description

tag to store the result

Expression SINT

INT

DINT

REAL

immediate tag an expression consisting of tags and/or immediate values separated by operators


Structured Text

Structured text does not have a CPT instruction, but you can achieve the same results using an assignment and expression. destination := numeric_expresion;

See Appendix C, Structured Text Programming for information on the syntax of assignments and expressions within structured text.

Description:

The CPT instruction performs the arithmetic operations you define in the expression. When enabled, the CPT instruction evaluates the expression and places the result in the Destination.

The execution of a CPT instruction is slightly slower and uses more memory than the execution of the other compute/math instructions. The advantage of the CPT instruction is that it allows you to enter complex expressions in one instruction.

TIP

There is no limit to the length of an expression.


Arithmetic status flags are affected.


none

248



Compute/Math Instructions (CPT, ADD, SUB, MUL, DIV, MOD, SQR, SQRT, NEG, ABS) Chapter 7

Execution:

Condition





The instruction evaluates the Expression and places the result in the Destination.



Example 1:

When enabled, the CPT instruction evaluates value_1 multiplied by 5 and divides that result by the result of value_2 divided by 7 and places the final result in result_1.

Example 2:

When enabled, the CPT instruction truncates float_value_1 and float_value_2, raises the truncated float_value_2 to the power of two and divides the truncated

float_value_1 by that result, and stores the remainder after the division in

float_value_result_cpt.



249

COS

DEG

FRD

LN

ACS

AND

ASN

ATN

Operator

-

+

*

/

**

ABS


Valid operators

Description

add subtract/negate multiply divide exponent (x to y) absolute value arc cosine bitwise AND arc sine arc tangent cosine radians to degrees

BCD to integer natural log

Optimal

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

REAL

DINT

REAL

REAL

REAL

DINT, REAL

DINT

REAL

SQR

TAN

TOD

TRN

XOR

Operator

LOG

MOD

NOT

OR

RAD

SIN

Description

log base 10 modulo-divide

Optimal

REAL


DINT, REAL


DINT, REAL

REAL

DINT





Operate On:


Use This Format: Examples:


•

tag_b + 5

•

tag_c AND tag_d

•

(tag_e ** 2) MOD (tag_f /

tag_g)

250




Determine the order of operation

7.

8.

9.

5.

6.

3.

4.



Order:

1.

2.

Operation:

( )



**

−

(negate), NOT

*, /, MOD

−

(subtract), +

AND

XOR

OR



251


Add (ADD)

Operands:

The ADD instruction adds Source A to Source B and places the result in the

Destination.

dest := sourceA + sourceB;

Relay Ladder

Operand: Type:

Source A SINT

INT

DINT

Source B

Format:

immediate tag

Description:

value to add to Source B

REAL


SINT immediate value to add to Source A tag INT

DINT

REAL


Destination SINT tag tag to store the result

INT

DINT

REAL

Structured Text

Use the plus sign “

+

” as an operator within an expression. This expression adds sourceA to sourceB and stores the result in dest.


Function Block

Operand: Type:

ADD tag FBD_MATH

Format:

structure

Description:

ADD structure

252



Compute/Math Instructions (CPT, ADD, SUB, MUL, DIV, MOD, SQR, SQRT, NEG, ABS) Chapter 7 postscan

FBD_MATH Structure

Input Parameter:

EnableIn

SourceA

SourceB

Data Type:

BOOL

REAL

REAL

Output Parameter: Data Type:

EnableOut

Dest

BOOL

REAL

Description:


Default is set.

Value to add to SourceB.

Valid = any float

Value to add to SourceA.

Valid = any float

Description:


Result of the math instruction. Arithmetic status flags are set for this output.

Description:

The ADD instruction adds Source A to Source B and places the result in the

Destination.




none

Execution:

Relay Ladder

Condition:


Action:



Destination = Source A + Source B





253


Condition:


EnableIn is cleared


Function Block

Action:

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

Add float_value_1 to float_value_2 and place the result in add_result.

Relay Ladder

Structured Text

add_result := float_value_1 + float_value_2;

Function Block

254




Subtract (SUB)

Operands:

The SUB instruction subtracts Source B from Source A and places the result in the Destination.

dest := sourceA - sourceB;

Relay Ladder

Operand: Type:

Source A SINT

INT

DINT

Source B

Format:

immediate tag

Description:

value from which to subtract Source B

REAL


SINT immediate value to subtract from Source A tag INT

DINT

REAL



INT

DINT

REAL

Structured Text

Use the minus sign “

−

” as an operator in an expression. This expression subtracts sourceB from sourceA and stores the result in dest.


Function Block

Operand: Type:

SUB tag FBD_MATH

Format:

structure

Description:

SUB structure



255

Chapter 6 Compute/Math Instructions (CPT, ADD, SUB, MUL, DIV, MOD, SQR, SQRT, NEG, ABS) postscan


Input Parameter:

EnableIn

SourceA

SourceB

Data Type:

BOOL

REAL

REAL


EnableOut

Dest

BOOL

REAL

Description:


Default is set.

Value from which to subtract SourceB.

Valid = any float

Value to subtract from SourceA.

Valid = any float

Description:



Description:

The SUB instruction subtracts Source B from Source A and places the result in the Destination.




none

Execution:

Relay Ladder

Condition:


Action:



Destination = Source B - Source A



256



Condition:


EnableIn is cleared



Function Block

Action:

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

Subtract float_value_2 from float_value_1 and place the result in subtract_result.

Relay Ladder

Structured Text

subtract_result := float_value_1 - float_value_2;

Function Block



257


Multiply (MUL)

Operands:

The MUL instruction multiplies Source A with Source B and places the result in the Destination.

dest := sourceA * sourceB;

Relay Ladder

Operand

Source A

Source B

Type

SINT

INT

DINT

Format

immediate tag

Description

value of the multiplicand

REAL


SINT immediate value of the multiplier tag INT

DINT

REAL



INT

DINT

REAL

Structured Text

Use the multiply sign “

∗

” as an operator in an expression. This expression multiplies sourceA by sourceB and stores the result in dest.


Function Block

Operand

MUL tag

Type

FBD_MATH

Format

structure

Description

MUL structure

258



Compute/Math Instructions (CPT, ADD, SUB, MUL, DIV, MOD, SQR, SQRT, NEG, ABS) Chapter 7 postscan


Input Parameter

EnableIn

Source A

Source B

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

REAL

Description


Default is set.

Value of the multiplicand.

Valid = any float

Value of the multiplier.

Valid = any float

Description



Description:

The MUL instruction multiplies Source A with Source B and places the result in the Destination.




none

Execution:

Relay Ladder

Condition


Action



Destination = Source B x Source A





259


Condition


EnableIn is cleared


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

Multiply float_value_1 by float_value_2 and place the result in multiply_result.

Relay Ladder

Structured Text

multiply_result := float_value_1

∗

float_value_2;

Function Block

260




Divide (DIV)

Operands:

The DIV instruction divides Source A by Source B and places the result in the

Destination.

dest := sourceA / sourceB;

Relay Ladder

Operand

Source A

Source B

Type

SINT

INT

DINT

Format

immediate tag

Description

value of the dividend

REAL


SINT immediate value of the divisor tag INT

DINT

REAL



INT

DINT

REAL

Structured Text

Use the divide sign “

/

” as an operator in an expression. This expression divides

sourceA by sourceB and stores the result in dest.




261


Function Block

Operand

DIV tag

Type

FBD_MATH


Format

structure

Description

DIV structure

Input Parameter

EnableIn

Source A

Source B

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

REAL

Description


Default is set.

Value of the dividend.

Valid = any float

Value of the divisor.

Valid = any float

Description



Description:

If the Destination is not a REAL, the instruction handles the fractional portion of the result as follows:

If Source A

and Source B are not

REALs or Source B is a REAL

Then The Fractional

Portion Of The Result

truncates

Example

rounds

Source A

Source B

Destination

Source A

Source B

Destination

DINT

DINT

DINT

REAL

DINT

DINT

3

2

5

3

1

5.0

262




If Source B (the divisor) is zero:

• a minor fault occurs:

–

Type 4: program fault

–

Code 4: arithmetic overflow

• the destination is set as follows:

And The Result Is: If Source B Is Zero And:

all operands are integers (SINT, INT, or DINT) at least one operand is a REAL

And The Destination Is a:

SINT, INT, or DINT

REAL positive negative positive negative

Then The Destination Is Set To:

Source A

-1

0

1.$ (positive infinity)

-1.$ (negative infinity)

To detect a possible divide-by-zero, examine the minor fault bit (S:MINOR).

See Logix5000 Controllers Common Procedures, publication 1756-PM001.




A Minor Fault Occurs If Fault Type

the divisor is zero 4

Fault Code

4

Execution:

Relay Ladder

Condition


Action



Destination = Source A / Source B





263


Condition


EnableIn is cleared


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example 1:

Divide float_value_1 by float_value_2 and place the result in divide_result.

Relay Ladder

Structured Text

divide_result := float_value_1 / float_value_2;

Function Block

264




Example 2:

The DIV and MOV instructions work together to divide two integers, round the result, and place the result in an integer tag:

•

The DIV instruction divides dint_a by dint_b.

•

To round the result, the Destination is a REAL tag. (If the destination was an integer tag (SINT, INT, or DINT), the instruction would truncate the result.)

•

The MOV instruction moves the rounded result (real_temp) from the

DIV to divide_result_rounded.

•

Since divide_result_rounded is a DINT tag the value from real_temp is rounded and placed in the DINT destination.

Relay Ladder

43009



265


Modulo (MOD)

The MOD instruction divides Source A by Source B and places the remainder in the Destination.

Operands:

Relay Ladder

Operand

Source A

Source B

Type

SINT

INT

DINT

Format

immediate tag

Description

value of the dividend

REAL


SINT immediate value of the divisor tag INT

DINT

REAL



INT

DINT

REAL

dest := sourceA MOD sourceB;

Structured Text

Use MOD as an operator in an expression. This expression divides sourceA by

sourceB and stores the remainder in dest.


Function Block

Operand

MOD tag

Type

FBD_MATH

Format

structure

Description

MOD structure

266





Input Parameter

EnableIn

Source A

Source B

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

REAL

Description


Default is set.

Value of the dividend.

Valid = any float

Value of the divisor.

Valid = any float

Description



Description:

If Source B (the divisor) is zero:

• a minor fault occurs:

–

Type 4: program fault

–

Code 4: arithmetic overflow

• the destination is set as follows:

If Source B Is Zero And

all operands are integers (SINT, INT, or DINT) at least one operand is a REAL

And The Destination Is a

SINT, INT, or DINT

And The Result Is

REAL positive negative positive negative

Then The Destination Is Set To

Source A

-1

0

1.$ (positive infinity)

-1.$ (negative infinity)

To detect a possible divide-by-zero, examine the minor fault bit (S:MINOR).

See Logix5000 Controllers Common Procedures, publication 1756-PM001.



267





A Minor Fault Occurs If Fault Type

the divisor is zero 4

Execution:

Relay Ladder

Condition


Condition


EnableIn is cleared postscan

Fault Code

4

Action



Destination = Source A – ( TRN ( Source A / Source B ) * Source B )



Function Block

Action

No action taken.

No action taken.

No action taken.


No action taken.

268




Example:

Divide dividend by divisor and place the remainder in remainder. In this example, three goes into 10 three times, with a remainder of one.

Relay Ladder

Structured Text

remainder := dividend MOD divisor;

Function Block



269


Square Root (SQR)

Operands:

The SQR instruction computes the square root of the Source and places the result in the Destination.

dest := SQRT(source);

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

Format

immediate tag

Description

find the square root of this value

REAL



INT

DINT

REAL

Structured Text

Use SQRT as a function. This expression computes the square root of source and stores the result in dest.


270




Function Block

Operand

SQR tag

Type

FBD_MATH_ADVANCED

FBD_MATH_ADVANCED Structure

Format

structure

Description

SQR structure

Input Parameter

EnableIn

Source

Data Type

BOOL

REAL


EnableOut

Dest

Data Type

BOOL

REAL

Description


Default is set.

Find the square root of this value.

Valid = any float

Description



Description:

If the Destination is not a REAL, the instruction handles the fractional portion of the result as follows:

If The Source Is

not a REAL a REAL

Then The Fractional

Portion Of The Result

truncates

Example

rounds

Source

Destination

Source

Destination

DINT

DINT

REAL

DINT

3

1

3.0

2

If the Source is negative, the instruction takes the absolute value of the Source before calculating the square root.




none



271


Condition


Condition


EnableIn is cleared


Execution:

Relay Ladder

Action



Destination

=

Source



Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

272




Example:

Calculate the square root of value_1 and place the result in sqr_result.

Relay Ladder

Structured Text

sqr_result := SQRT(value_1);

Function Block



273


Negate (NEG)

dest := -source;

Operands:

The NEG instruction changes the sign of the Source and places the result in the Destination.

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

Format

immediate tag

Description

value to negate

REAL



INT

DINT

REAL

Structured Text

Use the minus sign “

−

” as an operator in an expression. This expression changes the sign of source and stores the result in dest.


Function Block

Operand

NEG tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

NEG structure

274




Condition



Input Parameter

EnableIn

Source

Data Type

BOOL

REAL


EnableOut

Dest

Data Type

BOOL

REAL

Description


default is set

Value to negate.

valid = any float

Description



Description:

If you negate a negative value, the result is positive. If you negate a positive value, the result is negative.




none

Execution:

Relay Ladder

Action



Destination = 0

−

Source



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



275


Example:

Change the sign of value_1 and place the result in negate_result.

Relay Ladder

Structured Text

negate_result := -value_1;

Function Block

276




Absolute Value (ABS)

Operands:

The ABS instruction takes the absolute value of the Source and places the result in the Destination.

dest := ABS(source);

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

Format

immediate tag

Description

value of which to take the absolute value

REAL



INT

DINT

REAL

Structured Text

Use ABS as a function. This expression computes the absolute value of source and stores the result in dest.


Function Block

Operand

ABS tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

ABS structure



277


Condition



Input Parameter

EnableIn

Source

Data Type

BOOL

REAL


EnableOut

Dest

Data Type

BOOL

REAL

Description


Default is set.

Value of which to take the absolute value.

Valid = any float

Description



Description:

The ABS instruction takes the absolute value of the Source and places the result in the Destination.




none

Execution:

Relay Ladder

Action



Destination = | Source |



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

278




Example:

Place the absolute value of value_1 into value_1_absolute. In this example, the absolute value of negative four is positive four.

Relay Ladder

Structured Text

value_1_absolute := ABS(value_1);

Function Block



279


Notes:

280



Chapter

7

Move/Logical Instructions

(MOV, MVM, BTD, MVMT, BTDT, CLR, SWPB, AND, OR, XOR, NOT,

BAND, BOR, BXOR, BNOT)

Introduction



The move instructions modify and move bits.

If you want to

copy a value copy a specific part of an integer copy a specific part of an integer in function block

Use this instruction

MOV

MVM

MVMT

Available in these languages


(1) relay ladder structured text function block relay ladder

See page

283

285

288 move bits within an integer or between integers move bits within an integer or between integers in function block clear a value

BTD

BTDT

CLR structured text function block structured text

(1)

291

294

297 rearrange the bytes of a INT, DINT, or REAL tag SWPB relay ladder relay ladder 299 structured text

(1)




281

Chapter 7 Move/Logical Instructions (MOV, MVM, BTD, MVMT, BTDT, CLR, SWPB, AND, OR, XOR, NOT, BAND, BOR, BXOR, BNOT)

If you want to:

bitwise AND operation bitwise OR operation bitwise, exclusive OR operation bitwise NOT operation logically AND as many as eight boolean inputs.

Boolean AND (BAND) logically OR as many as eight boolean inputs.

Boolean OR (BOR) perform an exclusive OR on two boolean inputs. Boolean Exclusive OR

(BXOR) complement a boolean input.

The logical instructions perform operations on bits.

Use this instruction:

Bitwise AND

&

(1)

Bitwise OR

Bitwise XOR

Bitwise NOT

Boolean NOT (BNOT)






(2) function block structured text




(2) function block

(1)


(2)

In structured text, the AND, OR, XOR, and NOT operations can be bitwise or logical.

See page

303

306

310

314

317

320

323

326

282



Move/Logical Instructions (MOV, MVM, BTD, MVMT, BTDT, CLR, SWPB, AND, OR, XOR, NOT, BAND, BOR, BXOR, BNOT) Chapter 7

Move (MOV)

The MOV instruction copies the Source to the Destination. The Source remains unchanged.

Operands:

Relay Ladder

Operand: Type:

Source SINT

INT

DINT

Format

immediate tag

Description:

value to move (copy)

REAL



INT

DINT

REAL

Structured Text

dest := source;

Use an assignment “:=” with an expression. This assignment moves the value in source to dest.

See Appendix C, Structured Text Programming for information on the syntax of expressions and assignments within structured text.

Description:

The MOV instruction copies the Source to the Destination. The Source remains unchanged.




none



283


Condition


Execution:




The instruction copies the Source into the Destination.



Example:

Move the data in value_1 to value_2.

Relay Ladder

Structured Text

value_2 := value _1;

284




Masked Move (MVM)

The MVM instruction copies the Source to a Destination and allows portions of the data to be masked.

This instruction is available in structured text and function block as MVMT, see page 288 .

Operands:

Relay Ladder

Operand

Source

Mask

Type

SINT

INT

Format

immediate tag

Description

value to move

DINT


SINT immediate which bits to block or pass

INT tag

DINT



INT

DINT

Structured Text

dest := (Dest AND NOT (Mask))

OR (Source AND Mask);

This instruction is available in structured text as MVMT. Or you can combine bitwise logic within an expression and assign the result to the destination. This expression performs a masked move on Source.

See Appendix C, Structured Text Programming for information on the syntax of expressions and assignments within structured text.

Description:

The MVM instruction uses a Mask to either pass or block Source data bits. A

“1” in the mask means the data bit is passed. A “0” in the mask means the data bit is blocked.




285

Chapter 7 Move/Logical Instructions (MOV, MVM, BTD, MVMT, BTDT, CLR, SWPB, AND, OR, XOR, NOT, BAND, BOR, BXOR, BNOT) postscan

Enter an immediate mask value



Prefix

16#

8#

2#

Description


Arithmetic Status Flags


Fault Conditions

none

Execution:

Condition





The instruction passes the Source through the Mask and copies the result into the Destination. Unmasked bits in the Destination remain unchanged.



286




Example:

Copy data from value_a to value_b, while allowing data to be masked (a 0 masks the data in value_a).

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1

1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0

0 1 0 1 1 1 1 1 0 1 0 1 1 1 1 1 0 1 0 1 1 1 1 1 0 1 0 1 1 1 1 1

The shaded boxes show the bits that changed in value_b.

Relay Ladder

Structured Text

value_b := (value_b AND NOT (mask_2)) OR

(value_a AND mask_2);



287


Masked Move with Target

(MVMT)

The MVMT instruction first copies the Target to the Destination. Then the instruction compares the masked Source to the Destination and makes any required changes to the Destination. The Target and the Source remain unchanged.

This instruction is available in relay ladder as MVM, see page 285 .

Operands:

MVMT(MVMT_tag);

Structured Text

Variable Type

MVMT tag FBD_MASKED_MOVE

Format

structure

Description:

MVMT structure

Function Block

Operand Type

MVMT tag FBD_MASKED_MOVE

Format

structure

Description

MVMT structure

Input Parameter

EnableIn

Data Type

BOOL

Source

Mask

Target

DINT

DINT

DINT

FBD_MASKED_MOVE Structure

Description

Function Block



Default is set.

Structured Text


Input value to move to Destination based on value of Mask.

Valid = any integer

Mask of bits to move from Source to Dest. All bits set to one cause the corresponding bits to move from Source to Dest. All bits that are set to zero cause the corresponding bits not to move from Source to Dest.

Valid = any integer

Input value to move to Dest prior to moving Source bits through the Mask.

Valid = any integer

288





EnableOut

Dest

Data Type

BOOL

DINT

Description


Result of masked move instruction. Arithmetic status flags are set for this output.

Description:

When enabled, the MVMT instruction uses a Mask to either pass or block

Source data bits. A “1” in the mask means the data bit is passed. A “0” in the mask means the data bit is blocked.


Enter an Immediate Mask Value Using an Input Reference



Prefix

16#

8#

2#

Description





none

Execution:

Condition


EnableIn is cleared



No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.


No action taken.

No action taken.

No action taken.

na



No action taken.



289


Example:

1.

Copy Target into Dest.

Target 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

Dest 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

2.

Mask Source and compare it to Dest. Any required changes are made in

Dest. Source and Target remain unchanged. A 0 in the mask restrains the instruction from comparing that bit (shown by x in the example).

Source 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1

Mask1 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0

Dest 0 1 0 1 1 1 1 1 0 1 0 1 1 1 1 1 0 1 0 1 1 1 1 1 0 1 0 1 1 1 1 1

The shaded boxes show the bits that changed.

Structured Text

MVMT_01.Source := value_1;

MVMT_01.Mask := mask1;

MVMT_01.Target := target;

MVMT(MVMT_01); value_masked := MVMT_01.Dest;

Function Block

290




Bit Field Distribute (BTD)

The BTD instruction copies the specified bits from the Source, shifts the bits to the appropriate position, and writes the bits into the Destination.

This instruction is available in structured text and function block as BTDT, see page 294.

Operands:

Relay Ladder

Operand

Source

Type

SINT

INT

Description

tag that contains the bits to move

DINT


Source bit DINT immediate number of the bit (lowest bit number) from where to start the move

Destination SINT

(0-31 DINT)

(0-15 INT)

(0-7 SINT) tag must be within the valid range for the Source data type tag where to move the bits

INT

Destination bit

DINT

DINT

Format

immediate tag

Length DINT immediate

(0-31 DINT)

(0-15 INT)

(0-7 SINT) immediate

(1-32) the number of the bit (lowest bit number) where to start copying bits from the Source must be within the valid range for the

Destination data type number of bits to move

Description:

When enabled, the BTD instruction copies a group of bits from the Source to the Destination. The group of bits is identified by the Source bit (lowest bit number of the group) and the Length (number of bits to copy). The

Destination bit identifies the lowest bit number bit to start with in the

Destination. The Source remains unchanged.

If the length of the bit field extends beyond the Destination, the instruction does not save the extra bits. Any extra bits do not wrap to the next word.



not affected



291



none

Execution:

Condition





The instruction copies and shifts the Source bits to the Destination.



Example 1:

When enabled, the BTD instruction moves bits within value_1.

destination bit source bit

value_1

before BTD instruction

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0

value_1

after BTD instruction

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

The shaded boxes show the bits that changed in value_1.

292




Example 2:

When enabled, the BTD instruction moves 10 bits from value_1 to value_2.

source bit

value_1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 destination bit

value_2

before BTD instruction

0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

value_2

after BTD instruction

0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0

The shaded boxes show the bits that changed in value_2.



293


Bit Field Distribute with

Target (BTDT)

The BTDT instruction first copies the Target to the Destination. Then the instruction copies the specified bits from the Source, shifts the bits to the appropriate position, and writes the bits into the Destination. The Target and

Source remain unchanged.

This instruction is available in relay ladder as BTD, see page 291 .

Operands:

BTDT(BTDT_tag);

Structured Text

Variable

BTDT tag

Type

FBD_BIT_FIELD_DISTRIBUTE

Format

structure

Description

BTDT structure

Function Block

Operand

BTDT tag

Type

FBD_BIT_FIELD_DISTRIBUTE

Format

structure

Description

BTDT structure

Input Parameter

EnableIn

Data Type

BOOL

Source

SourceBit

Length

DINT

DINT

DINT

FBD_BIT_FIELD_DISTRIBUTE Structure

Description:

Function Block:



Default is set.



Input value containing the bits to move to Destination.

Valid = any integer

The bit position in Source (lowest bit number from where to start the move).

Valid = 0-31

Number of bits to move

Valid = 1-32

294




Input Parameter

DestBit

Target

Data Type

DINT

DINT


EnableOut BOOL

Dest DINT

Description:

The bit position in Dest (lowest bit number to start copying bits into).

Valid = 0-31

Input value to move to Dest prior to moving bits from the Source.

Valid = any integer

Description:


Result of the bit move operation. Arithmetic status flags are set for this output.

Description:

When enabled, the BTD instruction copies a group of bits from the Source to the Destination. The group of bits is identified by the Source bit (lowest bit number of the group) and the Length (number of bits to copy). The

Destination bit identifies the lowest bit number bit to start with in the


If the length of the bit field extends beyond the Destination, the instruction does not save the extra bits. Any extra bits do not wrap to the next word.


Arithmetic status flags are affected


none

Execution:

Condition


EnableIn is cleared



No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.


No action taken.

No action taken.

No action taken.

na



No action taken.



295


Example:

1.

The controller copies Target into Dest.

Target 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0

Dest 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0

2.

The SourceBit and the Length specify which bits in Source to copy into

Dest, starting at DestBit. Source and Target remain unchanged.

DestBit

SourceBit

Source 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0

Dest 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Structured Text

BTDT_01.Source := source;

BTDT_01.SourceBit := source_bit;

BTDT_01.Length := length;

BTDT_01.DestBit := dest_bit;

BTDT_01.Target := target;

BTDT(BTDT_01); distributed_value := BTDT_01.Dest;

Function Block

296



Clear (CLR)


The CLR instruction clears all the bits of the Destination.

Operands:

Relay Ladder

Operand Type

Destination SINT

INT

DINT

REAL

Format

tag

Description

tag to clear postscan dest := 0;

Structured Text

Structured text does not have a CLR instruction. Instead, assign 0 to the tag you want to clear. This assignment statement clears dest.

See Appendix C, Structured Text Programming for information on the syntax of expressions and assignment statements within structured text.

Description:

The CLR instruction clears all the bits of the Destination.




none

Execution:

Condition





The instruction clears the Destination.





297


Example:

Clear all the bits of value to 0.

Relay Ladder

Structured Text

value := 0;

298




Swap Byte (SWPB)

Operands:

The SWPB instruction rearranges the bytes of a value.

Relay Ladder

Operand

Source

Type

INT

DINT

REAL

Format

tag

Enter

tag that contains the bytes that you want to rearrange

Order Mode

Destination INT

DINT

REAL tag

If the Source

Is an

And You Want To Change the Bytes To

This Pattern (Each Letter Represents a

Different Byte)

INT

DINT

REAL n/a

ABCD

⇒

ABCD

⇒

ABCD

⇒ tag to store the bytes in the new order

If the Source

Is an

Then the Destination Must Be an

INT INT

DINT

REAL

DINT

DINT

REAL

Then Select

any of the options

REVERSE (or enter 0)

WORD (or enter 1)

HIGH/LOW (or enter 2)

Structured Text

SWPB(Source,OrderMode,Dest);

The operands are the same as those for the relay ladder SWPB instruction. If you select the HIGH/LOW order mode, enter it as HIGHLOW or

HIGH_LOW (without the slash).



299

Chapter 7 Move/Logical Instructions (MOV, MVM, BTD, MVMT, BTDT, CLR, SWPB, AND, OR, XOR, NOT, BAND, BOR, BXOR, BNOT) bar code reader

B A

42969

42968

A B


not affected


none

Execution:

Condition


EnableIn is set






Description:

The SWPB instruction rearranges the order of the bytes of the Source. It places the result in the Destination.

When you read or write ASCII characters, you typically do not need to swap characters. The ASCII read and write instructions (ARD, ARL, AWA, AWT) automatically swap characters, as shown below.

The instruction rearranges the specified bytes.


Tag Name

bar_code[0]

Value Style Type

AB ASCII INT


No action taken na na



The instruction rearranges the specified bytes.

No action taken.

300




Example 1:

The three SWPB instructions each reorder the bytes of DINT_1 according to a different order mode. The display style is ASCII, and each character represents one byte. Each instruction places the bytes, in the new order, in a different Destination.

Relay Ladder

Structured Text

SWPB(DINT_1,REVERSE,DINT_1_reverse);

SWPB(DINT_1,WORD,DINT_1_swap_word);

SWPB(DINT_1,HIGHLOW,DINT_1_swap_high_low);

Example 2:

The following example reverses the bytes in each element of an array. For an

RSLogix 5000 project that contains this example, open the

RSLogix 5000\Projects\Samples folder, Swap_Bytes_in_Array.ACD file.

1.

Initialize the tags. The SIZE instruction finds the number of elements in

array and stores that value in array_length. A subsequent instruction uses this value to determine when the routine has acted on all the elements in the array.

2.

Reverse the bytes in one element of array.

•

The SWPB instruction reverses the bytes of the element number that is indicated by the value of index. For example, when index equals 0, the

SWPB instruction acts on array[0].

•

The ADD instruction increments index. The next time the instruction executes, the SWPB instruction acts on the next element in array.

3.

Determine when the SWPB instruction has acted on all the elements in the array.

•

If index is less then the number of elements in the array (array_length), then continue with the next element in the array.

•

If index equals array_length, then the SWPB has acted on all the elements in the array.



301


Relay Ladder

Initialize the tags.

Reverse the bytes.

Determine whether the SWPB instruction has acted on all the elements in the array.

Structured Text

index := 0;

SIZE (array[0],0,array_length);

REPEAT

SWPB(array[index],REVERSE,array_bytes_reverse[index]); index := index + 1;

UNTIL(index >= array_length)END_REPEAT;

302




Bitwise AND (AND)

Operands:

The AND instruction performs a bitwise AND operation using the bits in

Source A and Source B and places the result in the Destination.

To perform a logical AND, see page 317 .

dest := sourceA AND sourceB

Relay Ladder

Operand

Source A

Source B

Type

SINT

INT

Format

immediate tag

Description

value to AND with Source B

DINT


SINT immediate value to AND with Source A

INT tag

DINT


Destination SINT tag stores the result

INT

DINT

Structured Text

Use AND or the ampersand sign “&” as an operator within an expression.

This expression evaluates sourceA AND sourceB.


Function Block

Operand

AND tag

Type

FBD_LOGICAL

Format

structure

Description

AND structure



303


FBD_LOGICAL Structure

Input Parameter

EnableIn

SourceA

SourceB

Data Type:

BOOL

DINT

DINT


EnableOut

Dest

Data Type

BOOL

DINT

Description


Default is set.

Value to AND with SourceB.

Valid = any integer

Value to AND with SourceA.

Valid = any integer

Description


Result of the instruction. Arithmetic status flags are set for this output.

postscan

Description:

When enabled, the instruction evaluates the AND operation:

1

1

0

0

If the Bit In

Source A Is

0

1

0

1

And the Bit In

Source B Is:

0

1

0

0

The Bit In the

Destination Is





none

Execution:

Relay Ladder

Condition


Action



The instruction performs a bitwise AND operation.



304




Condition


EnableIn is cleared


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

When enabled, the AND instruction performs a bitwise AND operation on

SourceA and SourceB and places the result in the Dest.

SourceA 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0 1 0 1 0 1 1 1 1 1 1 1 1 1

SourceB 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0

Dest 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0

Relay Ladder

Structured Text

value_result_and := value_1 AND value_2;

Function Block



305


Bitwise OR (OR)

Operands:

The OR instruction performs a bitwise OR operation using the bits in Source

A and Source B and places the result in the Destination.

To perform a logical OR, see page 320 .

dest := sourceA OR sourceB

Relay Ladder

Operand

Source A

Source B

Destination

Type

SINT

INT

Format

immediate tag

Description

value to OR with Source B

DINT


SINT immediate value to OR with Source A

INT tag

DINT


SINT tag stores the result

INT

DINT

Structured Text

Use OR as an operator within an expression. This expression evaluates sourceA

OR sourceB.


Function Block

Operand

OR tag

Type

FBD_LOGICAL

Format:

structure

Description

OR structure

306





Input Parameter

EnableIn

SourceA

SourceB

Data Type

BOOL

DINT

DINT


EnableOut

Dest

Data Type

BOOL

DINT

Description


Default is set.

Value to OR with SourceB.

Valid = any integer

Value to OR with SourceA.

Valid = any integer

Description



postscan

Description:

When enabled, the instruction evaluates the OR operation:

1

1

0

0

If the Bit In

Source A Is

0

1

0

1

And the Bit In

Source B Is

1

1

0

1

The Bit In the

Destination Is





none

Execution:

Relay Ladder

Condition


Action



The instruction performs a bitwise OR operation.





307


Condition


EnableIn is cleared


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

When enabled, the OR instruction performs a bitwise OR operation on

SourceA and SourceB and places the result in Dest.

SourceA 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0 1 0 1 0 1 1 1 1 1 1 1 1 1

SourceB 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0

Dest 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 0 1 0 1 1 1 1 1 1 1 1 1

Relay Ladder

Structured Text

value_result_or := value_1 OR value_2;

308




Function Block



309


Bitwise Exclusive OR (XOR)

The XOR instruction performs a bitwise XOR operation using the bits in

Source A and Source B and places the result in the Destination.

To perform a logical XOR, see page 323 .

Operands:

Relay Ladder

Operand

Source A

Source B

Destination

Type

SINT

INT

Format

immediate tag

Description

value to XOR with Source B

DINT


SINT immediate value to XOR with Source A

INT tag

DINT



INT

DINT dest := sourceA XOR sourceB

Structured Text

Use XOR as an operator within an expression. This expression evaluates

sourceA XOR sourceB.


Function Block

Operand

XOR tag

Type

FBD_LOGICAL

Format

structure

Description

XOR structure

310





Input Parameter

EnableIn

SourceA

SourceB

Data Type

BOOL

DINT

DINT

Output Parameter: Data Type

EnableOut

Dest

BOOL

DINT

Description


Default is set.

Value to XOR with SourceB.

Valid = any integer

Value to XOR with SourceA.

Valid = any integer

Description



postscan

Description:

When enabled, the instruction evaluates the XOR operation:

1

1

0

0

If the Bit In

Source A Is

0

1

0

1

And the Bit In

Source B Is

1

0

0

1

The Bit In the

Destination Is





none

Execution:

Relay Ladder

Condition


Action



The instruction performs a bitwise OR operation.





311


Condition


EnableIn is cleared


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

When enabled, the XOR instruction performs a bitwise XOR operation on

SourceA and SourceB and places the result in the destination tag.

value_1 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0 1 0 1 0 1 1 1 1 1 1 1 1 1

value_2 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0

value_result_xor 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0 1 0 0 1 0 1 1 1 1 1 1 1 1 1

Relay Ladder

Structured Text

value_result_xor := value_1 XOR value_2;

312




Function Block



313


Bitwise NOT (NOT)

Operands:

The NOT instruction performs a bitwise NOT operation using the bits in the

Source and places the result in the Destination.

To perform a logical NOT, see page 326.

dest := NOT source

Relay Ladder

Operand

Source

Destination

Type

SINT

INT

Format

immediate tag

Description

value to NOT

DINT



INT

DINT

Structured Text

Use NOT as an operator within an expression. This expression evaluates NOT

source.


Function Block

Operand

NOT tag

Type

FBD_LOGICAL

Format

structure

Description

NOT structure

314



Move/Logical Instructions (MOV, MVM, BTD, MVMT, BTDT, CLR, SWPB, AND, OR, XOR, NOT, BAND, BOR, BXOR, BNOT) Chapter 7 postscan


Input Parameter

EnableIn

Source

Data Type

BOOL

DINT


EnableOut

Dest

Data Type

BOOL

DINT

Description


default is set

Value to NOT.

valid = any integer

Description



Description:

When enabled, the instruction evaluates the NOT operation:

If the Bit In the

Source Is:

0

1

The Bit In the

Destination Is:

1

0





none

Execution:

Relay Ladder

Condition


Action



The instruction performs a bitwise NOT operation.





315


Condition


EnableIn is cleared


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

When enabled, the NOT instruction performs a bitwise NOT operation on

Source and places the result in Dest.

value_1 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0 1 0 1 0 1 1 1 1 1 1 1 1 1

value_result_not 1 1 1 1 1 1 1 1 1 1 1 1 1 0 1 0 1 0 1 0 1 0 1 0 0 0 0 0 0 0 0 0

Relay Ladder

Structured Text

value_result_not := NOT value_1;

Function Block

316




Boolean AND (BAND)

The BAND instruction logically ANDs as many as 8 boolean inputs.

To perform a bitwise AND, see page 303 .

Operands:

Structured Text

IF operandA AND operandB THEN

<statement>;

END_IF;

Use AND or the ampersand sign “&” as an operator within an expression.

The operands must be BOOL values or expressions that evaluate to BOOL values. This expression evaluates whether operandA and operandB are both set

(true).

See Appendix B for information on the syntax of expressions within structured text.

Function Block

Operand

BAND tag

Type

FBD_BOOLEAN_AND

Format

structure

Description

BAND structure

Input Parameter

EnableIn

Data Type

BOOL

In1

In2

In3

In4

In5

In6

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

FBD_BOOLEAN_AND Structure

Description


Default is set.

First boolean input.

Default is set.

Second boolean input.

Default is set.

Third boolean input.

Default is set.

Fourth boolean input.

Default is set.

Fifth boolean input.

default is set.

Sixth boolean input.

Default is set.



317


Input Parameter

In7

In8

Data Type

BOOL

BOOL


EnableOut

Out

Data Type

BOOL

BOOL

Description

Seventh boolean input.

Default is set.

Eighth boolean input.

Default is set.

Description

Enable output.

The output of the instruction.

postscan

Description:

The BAND instruction ANDs as many as eight boolean inputs. If an input is not used, it defaults to set (1).

Out = In1 AND In2 AND In3 AND In4 AND In5 AND In6 AND In7 AND In8


not affected


none

Execution:

Condition


EnableIn is cleared

EnableIn is set


No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example 1:

This example ANDs bool_in1 and bool_in2 and places the result in

value_result_and.

1

1

If BOOL_IN1 Is If BOOL_IN2 Is Then VALUE_RESULT_AND Is

0

0

0

1

0

0

0

1

0

1

Structured Text

value_result_and := bool_in1 AND bool_in2;

318




Function Block

Example 2:

If both bool_in1 and bool_in2 are set (true), light1 is set (on). Otherwise, light1 is cleared (off).

Structured Text

IF bool_in1 AND bool_in2 THEN

ELSE light1 := 1; light1 := 0;

END_IF;



319


Boolean OR (BOR)

The BOR instruction logically ORs as many as eight boolean inputs.

To perform a bitwise OR, see page 306 .

Operands:

IF operandA OR operandB THEN

<statement>;

END_IF;

Structured Text

Use OR as an operator within an expression. The operands must be BOOL values or expressions that evaluate to BOOL values. This expression evaluates whether operandA or operandB or both are set (true).


Function Block

Operand

BOR tag

Type

FBD_BOOLEAN_OR

Format

structure

Description

BOR structure

Input Parameter

EnableIn

Data Type

BOOL

In1

In2

In3

In4

In5

In6

In7

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

FBD_BOOLEAN_OR Structure

Description


Default is set.


Default is cleared.


Default is cleared.

Third boolean input.

Default is cleared.

Fourth boolean input.

Default is cleared.

Fifth boolean input.

Default is cleared.

Sixth boolean input.

Default is cleared.

Seventh boolean input.

Default is cleared.

320




Input Parameter

In8

Data Type

BOOL


EnableOut

Out

Data Type

BOOL

BOOL

Description

Eighth boolean input.

Default is cleared.

Description

Enable output.


Description:

The BOR instruction ORs as many as eight boolean inputs. If an input is not used, it defaults to cleared (0).

Out = In1 OR In2 OR In3 OR In4 OR In5 OR In6 OR In7 OR In8


not affected


none

Execution:

Condition


EnableIn is cleared



No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example 1:

This example ORs bool_in1 and bool_in2 and places the result in value_result_or.

1

1

If BOOL_IN1 Is If BOOL_IN2 Is: Then VALUE_RESULT_OR Is:

0

0

0

1

0

1

0

1

1

1

Structured Text

value_result_or := bool_in1 OR bool_in2;



321


Function Block

Example 2:

In this example, light1 is set (on) if:

• only bool_in1 is set (true).


• both bool_in1 and bool_in2 are set (true).

Otherwise, light1 is cleared (off).

Structured Text

IF bool_in1 OR bool_in2 THEN light1 := 1;

ELSE light1 := 0;

END_IF;

322




Boolean Exclusive OR

(BXOR)

The BXOR performs an exclusive OR on two boolean inputs.

To perform a bitwise XOR, see page 310 .

Operands:

Structured Text

IF operandA XOR operandB THEN

<statement>;

END_IF;

Use XOR as an operator within an expression. The operands must be BOOL values or expressions that evaluate to BOOL values. This expression evaluates whether only operandA or only operandB is set (true).


Function Block

Operand

BXOR tag

Type

FBD_BOOLEAN_XOR

Format

structure

Description

BXOR structure

FBD_BOOLEAN_XOR Structure

Input Parameter

EnableIn

In1

In2

Data Type

BOOL

BOOL

BOOL


EnableOut

Out

Data Type

BOOL

BOOL

Description


Default is set.


Default is cleared.


Default is cleared.

Description

Enable output.


Description:

The BXOR instruction performs an exclusive OR on two boolean inputs.

Out = In1 XOR In2


not affected


none



323


Condition


EnableIn is cleared


Execution:


No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example 1:

This example performs an exclusive OR on bool_in1 and bool_in2 and places the result in value_result_xor.

0

1

If BOOL_IN1 Is If BOOL_IN2 Is Then VALUE_RESULT_XOR Is

0 0 0

1

1

0

1

1

1

0

Structured Text

value_result_xor := bool_in1 XOR bool_in2;

Function Block

324




Example 2:

In this example, light1 is set (on) if



Otherwise, light1 is cleared (off).

Structured Text

IF bool_in1 XOR bool_in2 THEN


END_IF;



325


Boolean NOT (BNOT)

Operands:

The BNOT instruction complements a boolean input.

To perform a bitwise NOT, see page 314 .

IF NOT operand THEN

<statement>;

END_IF;

Structured Text

Use NOT as an operator within an expression. The operand must be a BOOL values or expressions that evaluate to BOOL values. This expression evaluates whether operand is cleared (false).


Function Block

Operand

BNOT tag

Type

FBD_BOOLEAN_NOT

Format

structure

Description

BNOT structure

FBD_BOOLEAN_NOT Structure

Input Parameter

EnableIn

In

Data Type

BOOL

BOOL


EnableOut

Out

Data Type

BOOL

BOOL

Description


Default is set.

Input to the instruction.

Default is set.

Description:

Enable output.


Description:

The BNOT instruction complements a boolean input.

Out = NOT In


not affected


none

326




Condition


EnableIn is cleared


Execution:


No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example 1:

This example complements bool_in1 and places the result in value_result_not.

If BOOL_IN1 Is

0

1

Then VALUE_RESULT_NOT Is

1

0

Structured Text

value_result_not := NOT bool_in1;

Function Block

Example 2:

If bool_in1 is cleared, light1 is cleared (off). Otherwise, light1 is set (on).

Structured Text

IF NOT bool_in1 THEN


END_IF;



327


Notes:

328



Chapter

8

Array (File)/Misc. Instructions

(FAL, FSC, COP, CPS, FLL, AVE, SRT, STD, SIZE)

Introduction

The file/miscellaneous instructions operate on arrays of data.

If You Want To

perform arithmetic, logic, shift, and function operations on values in arrays search for and compare values in arrays copy the contents of one array into another array


FAL

FSC

COP



(1) relay ladder relay ladder structured text relay ladder

See Page

335

346

355 copy the contents of one array into another array without interruption

CPS 355 fill an array with specific data calculate the average of an array of values

FLL

AVE structured text relay ladder structured text

(1) relay ladder

361

365 sort one dimension of array data into ascending order

SRT structured text

(1) relay ladder structured text relay ladder

370 calculate the standard deviation of an array of values

STD 375 find the size of a dimension of an array SIZE structured text


(1)


381





329

Chapter 8 Array (File)/Misc. Instructions (FAL, FSC, COP, CPS, FLL, AVE, SRT, STD, SIZE)

Selecting Mode of

Operation

For FAL and FSC instructions, the mode tells the controller how to distribute the array operation.

If You Want To

operate on all of the specified elements in an array before continuing on to the next instruction distribute array operation over a number of scans

Select This Mode

All

Numerical enter the number of elements to operate on per scan

(1-2147483647) manipulate one element of the array each time the rung-condition-in goes from false to true

Incremental

All mode

In All mode, all the specified elements in the array are operated on before continuing on to the next instruction. The operation begins when the instruction’s rung-condition-in goes from false to true. The position (.POS) value in the control structure points to the element in the array that the instruction is currently using. Operation stops when the .POS value equals the

.LEN value.

Data array one scan

16639

330



Array (File)/Misc. Instructions (FAL, FSC, COP, CPS, FLL, AVE, SRT, STD, SIZE) Chapter 8

The following timing diagram shows the relationship between status bits and instruction operation. When the instruction execution is complete, the .DN bit is set. The .DN bit, the .EN bit, and the .POS value are cleared when the rung-condition-in is false. Only then can another execution of the instruction be triggered by a false-to-true transition of rung-condition-in.

one scan rung-condition-in

.EN bit

.DN bit scan of the instruction operation complete clears status bits and clears .POS value no execution occurs

40010

Numerical mode

Numerical mode distributes the array operation over a number of scans. This mode is useful when working with non-time-critical data or large amounts of data. You enter the number of elements to operate on for each scan, which keeps scan time shorter.



331


Execution is triggered when the rung-condition-in goes from false to true.

Once triggered, the instruction is executed each time it is scanned for the number of scans necessary to complete operating on the entire array. Once triggered, rung-condition-in can change repeatedly without interrupting execution of the instruction.

one scan second scan next scan

16641

332

IMPORTANT

Avoid using the results of a file instruction operating in numerical mode until the .DN bit is set.

The following timing diagram shows the relationship between status bits and instruction operation. When the instruction execution is complete, the .DN bit is set.

rung is true at completion

multiple scans

rung is false at completion

multiple scans rung-condition-in

.EN bit

.DN bit scan of the instruction operation complete operation complete

40013 clears status bits and clears .POS value clears status bits and clears .POS value




If the rung-condition-in is true at completion, the .EN and .DN bit are set until the rung-condition-in goes false. When the rung-condition-in goes false, these bits are cleared and the .POS value is cleared.

If the rung-condition-in is false at completion, the .EN bit is cleared immediately. One scan after the .EN bit is cleared, the .DN bit and the .POS value are cleared.

Incremental mode

Incremental mode manipulates one element of the array each time the instruction’s rung-condition-in goes from false to true.

1st instruction enable

2nd instruction enable

3rd instruction enable last instruction enable

16643



333


The following timing diagram shows the relationship between status bits and instruction operation. Execution occurs only in a scan in which the rung-condition-in goes from false to true. Each time this occurs, only one element of the array is manipulated. If the rung-condition-in remains true for more than one scan, the instruction only executes during the first scan.

one scan rung-condition-in

.EN bit

.DN bit scan of the instruction operation complete

40014 clears status bits and clears .POS value

The .EN bit is set when rung-condition-in is true. The .DN bit is set when the last element in the array has been manipulated. When the last element has been manipulated and the rung-condition-in goes false, the .EN bit, the .DN bit, and the .POS value are cleared.

The difference between incremental mode and numerical mode at a rate of one element per scan is:

•

Numerical mode with any number of elements per scan requires only one false-to-true transition of the rung-condition-in to start execution.

The instruction continues to execute the specified number of elements each scan until completion regardless of the state of the rung-condition-in.

•

Incremental mode requires the rung-condition-in to change from false to true to manipulate one element in the array.

334




File Arithmetic and Logic

(FAL)

Operands:

The FAL instruction performs copy, arithmetic, logic, and function operations on data stored in an array.

Relay Ladder

Operand

Control

Length

Position

Mode

Destination

Expression

Type

CONTROL

DINT

DINT

DINT

Format

tag immediate immediate immediate

Description

control structure for the operation number of elements in the array to be manipulated current element in array initial value is typically 0 how to distribute the operation select INC, ALL, or enter a number tag to store the result SINT

INT tag

DINT

REAL

SINT immediate tag an expression consisting of tags and/or immediate values separated by operators INT

DINT

REAL


Structured Text

Structured text does not have an FAL instruction, but you can achieve the same results using a SIZE instruction and a FOR...DO or other loop construct.

SIZE(destination,0,length-1);

FOR position = 0 TO length DO destination[position] := numeric_expression;

END_FOR;

See Appendix C, Structured Text Programming for information on the syntax of constructs within structured text.



335


CONTROL Structure

Mnemonic

.EN

.DN

.ER

.LEN

.POS

Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the FAL instruction is enabled.

The done bit is set when the instruction has operated on the last element (.POS = .LEN).

The error bit is set if the expression generates an overflow (S:V is set). The instruction stops executing until the program clears the .ER bit. The .POS value contains the position of the element that caused the overflow.

The length specifies the number of elements in the array on which the FAL instruction operates.

The position contains the position of the current element that the instruction is accessing.

Description:

The FAL instruction performs the same operations on arrays as the CPT instruction performs on elements.

The examples that start on page 342 show how to use the .POS value to step through an array. If a subscript in the expression of the Destination is out of range, the FAL instruction generates a major fault (type 4, code 20).




A Major Fault Will Occur If

subscript is out of range

.POS < 0 or .LEN < 0

Fault Type

4

4

Fault Code

20

21

336




Condition


Execution:



examine .DN bit

.DN bit = 0

.DN bit = 1

.EN bit is cleared

.ER bit is cleared

INC mode yes

.EN bit is cleared no

internal bit is cleared

ALL mode yes no

.LEN < 0 or

.POS < 0 yes no

.POS = .POS + 1 major fault

.POS = 0 no

.POS = .POS - 1 yes

.DN bit is set

.DN bit is set yes no

.LEN = 0 no

.POS < .LEN

yes

.LEN > mode no yes

mode = .LEN

numeric mode page 341 rung-condition-out is set to

false

end



337


Condition



examine .ER bit

.ER bit = 0

.ER bit = 1 examine .DN bit

.DN bit = 1

.DN bit = 0

.LEN < 0 or

.POS < 0 yes no no

.LEN = 0 yes

.DN bit is set major fault

INC mode no yes

INC mode page 339 common no

ALL mode yes

ALL mode page 340 page 341 numeric mode

loop_count =

loop_count - 1

loop_count < 0 no yes

.POS = .POS + 1

.POS = .POS + 1 evaluate expression examine S:V no

.ER bit is set yes

338

.POS = .LEN

no yes

.DN bit is set

.POS = .POS + 1 rung-condition-out is set to

true

end



Condition

INC mode examine .EN bit

.EN bit = 1

.EN bit = 0



examine

internal bit

bit = 0

bit = 1

.POS = .POS + 1

internal bit is set

.POS

≥

.LEN

yes no

.EN bit is set

loop_count = 1

.POS = 0 no

.POS = .POS - 1 yes

.DN bit is set common page 338 rung-condition-out is set to

true

end



339


Relay Ladder Action Condition

ALL mode examine .EN bit

.EN bit = 0

.EN bit = 1

.POS = .POS + 1 examine

internal bit

.EN bit is set

bit = 0

bit = 1

.POS

≥

.LEN

yes no

loop_count = .LEN - .POS

.POS = 0 yes no

.POS = .POS - 1 common page 338

.DN bit is set rung-condition-out is set to

true

end

340




Condition

numeric mode

.POS = .POS + 1

.EN bit = 1 examine .EN bit

.EN bit = 0 examine

internal bit

bit = 0

bit = 1

internal bit is set


mode = .LEN

.POS

≥

.LEN

yes no no

.LEN

≥

mode yes

.EN bit is set

loop_count = .LEN - .POS

.POS = 0 no

.POS = .POS - 1

.DN bit is set yes postscan mode

≥

loop_count

yes no

.EN bit is set common page 338



true

end



341


Example 1:

When enabled, the FAL instruction copies each element of array_2 into the same position within array_1.

array-to-array copy

Expression: Destination:

Example 2:

When enabled, the FAL instruction copies value_1 into the first 10 positions of the second dimension of array_2.

element-to-array copy


Example 3:

Each time the FAL instruction is enabled, it copies the current value of array_1 to value_1. The FAL instruction uses incremental mode, so only one array value is copied each time the instruction is enabled. The next time the instruction is enabled, the instruction overwrites value_1 with the next value in

array_1.

array-to-element copy


Example 4:

When enabled, the FAL instruction adds value_1 and value_2 and stores the result in the current position of array_1.

arithmetic operation: (element + element) to array

Expression:

Destination:

342




Example 5:

When enabled, the FAL instruction divides the value in the current position of

array_2 with the value in the current position of array_3 and stores the result in the current position of array_1.

arithmetic operation: (array / array) to array


Example 6:

When enabled, the FAL instruction adds the value at the current position in

array_1 to value_1 and stores the result in the current position in array_3. The instruction must execute 10 times for the entire array_1 and array_3 to be manipulated.

arithmetic operation: (array + element) to array

Expression:

Destination:

Example 7:

Each time the FAL instruction is enabled, it adds value_1 to the current value of array_1 and stores the result in value_2. The FAL instruction uses incremental mode, so only one array value is added to value_1 each time the instruction is enabled. The next time the instruction is enabled, the instruction overwrites value_2.

arithmetic operation: (element + array) to element




343


Example 8:

When enabled, the FAL instruction multiplies the current value of array_1 by the current value of array_3 and stores the result in value_1. The FAL instruction uses incremental mode, so only one pair of array values is multiplied each time the instruction is enabled. The next time the instruction is enabled, the instruction overwrites value_1.

arithmetic operation: (array

∗

array) to element

Expression:

Destination:

COS

DEG

FRD

LN

ACS

AND

ASN

ATN

Operator

-

+

*

/

**

ABS

FAL Expressions

You program expressions in FAL instructions the same as expressions in CPT instructions. Use the following sections for information on valid operators, format, and order of operation, which are common to both instructions.

Valid operators

Description

add subtract/negate multiply divide exponent (x to y) absolute value arc cosine bitwise AND arc sine arc tangent cosine radians to degrees

BCD to integer natural log

Optimal

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

REAL

DINT

REAL

REAL

REAL

DINT, REAL

DINT

REAL

SQR

TAN

TOD

TRN

XOR

Operator

LOG

MOD

NOT

OR

RAD

SIN

Description

log base 10 modulo-divide

Optimal

REAL


DINT, REAL


DINT, REAL

REAL

DINT


344







Operate On




•

tag_b + 5

•

tag_c AND tag_d

•

(tag_e ** 2) MOD (tag_f /

tag_g)


6.

7.

8.

9.

3.

4.

5.



Order

1.

2.

Operation

( )



**

−

(negate), NOT

*, /, MOD

−

(subtract), +

AND

XOR

OR



345


File Search and Compare

(FSC)

Operands:

The FSC instruction compares values in an array, element by element.

Relay Ladder

Operand

Control

Length

Position

Type

CONTROL

DINT

DINT

Format

tag

Description

control structure for the operation immediate number of elements in the array to be manipulated immediate offset into array initial value is typically 0


Mnemonic

.EN

.DN

.ER

.IN

.FD

.LEN

.POS

Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the FSC instruction is enabled.

The done bit is set when the instruction has operated on the last element

(.POS = .LEN).

The error bit is not modified.

The inhibit bit indicates that the FSC instruction detected a true comparison. You must clear this bit to continue the search operation.

The found bit indicates that the FSC instruction detected a true comparison.

The length specifies the number of elements in the array on which the instruction operates.


Description:

When the FSC instruction is enabled and the comparison is true, the instruction sets the .FD bit and the .POS bit reflects the array position where the instruction found the true comparison. The instruction sets the .IN bit to prevent further searching.






Fault Type

4

Fault Code

21

346




Condition


Execution:



examine .DN bit

.DN bit = 0

.DN bit = 1

.EN bit is cleared

.ER bit is cleared

INC mode yes

.EN bit is cleared no

internal bit is cleared

ALL mode yes no

.LEN < 0 or

.POS < 0 yes no

.POS = .POS + 1 major fault rung-condition-out is set to

false

end

.POS = 0 no

.POS = .POS - 1 yes

.DN bit is set

.DN bit is set yes no

.LEN = 0 no

.POS < .LEN

yes

.LEN > mode no yes

mode = .LEN

numeric mode page 341



347


Condition



examine .ER bit

.ER bit = 1

.ER bit = 0

.DN bit = 1 examine .IN bit

.IN bit = 0

.DN bit = 0

.LEN < 0 or

.POS < 0 yes no no

.LEN = 0 yes

.DN bit is set major fault

INC mode yes

.DN bit = 1 examine .DN bit common

INC mode page 339 no

.DN bit = 0

loop_count =

loop_count - 1 no

ALL mode yes

ALL mode page 340 page 341 numeric mode

loop_count < 0 no yes

.POS = .POS + 1 evaluate comparison postscan

348

.POS = .POS + 1 match yes

.EN bit is set

.FD bit is set no

.POS = .LEN

no yes

.DN bit is set

.POS = .POS + 1 rung-condition-out is set to

true

end





Example 1:

Search for a match between two arrays. When enabled, the FSC instruction compares each of the first 10 elements in array_1 to the corresponding elements in array_2.

array_1

00000000000000000000000000000000

00000000000000000000000000000000

00000000000000000000000000000000

00000000000000000000000000000000

00000000000000001111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

array_2

00000000000000000000000000000000

00000000000000000000000000000000

00000000000000000000000000000000

00000000000000000000000000000000

11111111111111110000000000000000

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

control_3.pos

6

7

4

5

8

9

2

3

0

1

The FSC instruction finds that these elements are not equal. The instruction sets the .FD and .IN bits. The .POS value (4) indicates the position of the elements that are not equal. To continue comparing the rest of the array, clear the .IN bit.



349


Example 2:

Search for a match in an array. When enabled, the FSC instruction compares the MySearchKey to 10 elements in array_1.

MySearchKey

11111111111111110000000000000000

reference

00000000000000000000000000000000

00000000000000000000000000000000

00000000000000000000000000000000

00000000000000000000000000000000

11111111111111110000000000000000

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

11111111111111111111111111111111

control_3.pos

6

7

4

5

8

9

2

3

0

1

The FSC instruction finds that this array element equals MySearchKey. The instruction sets the .FD and .IN bits. The

.POS (4) value indicates the position of the equal element. To continue comparing the rest of the array, clear the .IN bit.

350



code

SAM


Example 3:

Search for a string in an array of strings. When enabled, the FSC instruction compares the characters in code to 10 elements in code_table.

code_table

SAM

FQG

CLE

CAK

AFG

BEH

HUO

SAK

DET

BWG

code_table_search.POS

6

7

4

5

8

9

2

3

0

1

The FSC instruction finds that this array element equals code. The instruction sets the .FD and .IN bits. The .POS (4) value indicates the position of the equal element.

To continue comparing the rest of the array, clear the .IN bit.

FSC expressions

You program expressions in FSC instructions the same as expressions in CMP instructions. Use the following sections for information on valid operators, format, and order of operation, which are common to both instructions.



351

**

ABS

ACS

AND

<=

>

>=

<>

=

<

*

/

Operator

-

+

ASN

ATN

COS


Valid Operators

Description

add subtract/negate multiply divide equal less than

Optimal

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL less than or equal greater than

DINT, REAL

DINT, REAL greater than or equal DINT, REAL not equal DINT, REAL exponent (x to y) absolute value arc cosine bitwise AND

DINT, REAL

DINT, REAL

REAL

DINT arc sine arc tangent cosine

REAL

REAL

REAL

TAN

TOD

TRN

XOR

OR

RAD

SIN

SQR

Operator

DEG

FRD

LN

LOG

MOD

NOT

Description

radians to degrees

BCD to integer

Optimal

DINT, REAL

DINT natural log log base 10

REAL

REAL modulo-divide DINT, REAL bitwise complement DINT bitwise OR degrees to radians sine square root

DINT

DINT, REAL

REAL

DINT, REAL tangent integer to BCD

REAL

DINT truncate DINT, REAL bitwise exclusive OR DINT




Operate On




•

tag_b + 5

•

tag_c AND tag_d

•

(tag_e ** 2) MOD (tag_f /

tag_g)

352





7.

8.

9.

10.

5.

6.

3.

4.



Order

1.

2.

Operation

( )



**

−

(negate), NOT

*, /, MOD

<, <=, >, >=, =

−

(subtract), +

AND

XOR

OR



353


Use Strings In an Expression

To use strings of ASCII characters in an expression, follow these guidelines:

•

An expression lets you compare two string tags.

•

You cannot enter ASCII characters directly into the expression.

•

Only the following operators are permitted

<=

>

>=

<>

Operator

=

<

Description


•


•


•


•

When the two strings are sorted as in a telephone directory, the order of the strings determines which one is greater. s s e l e r t e r e a g r

A

AB

B a ab


1ab $31$61$62

1b $31$62

$41

$41$42

$42

$61

$61$62

AB B

354




Copy File (COP)

Synchronous Copy File

(CPS)

Operands:

The COP and CPS instructions copy the value(s) in the Source to the


Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL string

structure

Destination

SINT

Length

INT

DINT

REAL string

structure

DINT

Format

tag tag

Description

initial element to copy

Important: the Source and Destination operands should be the same data type, or unexpected results may occur initial element to be overwritten by the Source

Important: the Source and Destination operands should be the same data type, or unexpected results may occur immediate tag number of Destination elements to copy

COP(Source,Dest,Length);

CPS(Source,Dest,Length);

Structured Text

The operands are the same as those for the relay ladder COP and

CPS instructions.



355


Description:

During execution of the COP and CPS instructions, other controller actions may try to interrupt the copy operation and change the source or destination data:

If the Source Or Destination Is

• produced tag

• consumed tag

•

I/O data

• data that another task can overwrite none of the above

ATTENTION

And You Want To

prevent the data from changing during the copy operation allow the data to change during the copy operation

Then Select Notes

CPS

•

Tasks that attempt to interrupt a CPS instruction are delayed until the instruction is done.

•

To estimate the execution time of the

CPS instruction, see ControlLogix

System User Manual, publication

1756-UM001.

COP

COP

The number of bytes copied is:

Byte Count = Length

∗

(number of bytes in the Destination data type)

If the byte count is greater than the length of the Source, unpredictable data is copied for the remaining elements.

356

IMPORTANT

You must test and confirm that the instruction doesn’t change data that you don’t want it to change.

The COP and CPS instructions operate on contiguous memory. They do a straight byte-to-byte memory copy. In some cases, they write past the array into other members of the tag. This happens if the length is too big and the tag is a user-defined data type.

If The Tag Is

user-defined data type

NOT user-defined data type

Then

If the Length is too big, the instruction writes past the end of the array into other members of the tag. It stops at the end of the tag. No major fault is generated.

If the Length is too big, the instruction stops at the end of the array. No major fault is generated.

The Length is too big if it is more than the total number of elements in the

Destination array.


not affected


none




Execution:

Condition


EnableIn is set instruction execution






na


No action taken.

na na



end_address = start_address + (Length

∗ number of bytes in a destination element) postscan

end_address > end of destination array yes no

source_address = Source

end_address = end of destination array

destination_address =

end_address

yes no copy data in source_address to destination

_address

source_address = source _address + 1


destination_address + 1


No action taken.


true

end



357


Example 1:

Both array_4 and array_5 are the same data type. When enabled, the COP instruction copies the first 10 elements of array_4 into the first 10 elements of

array_5.

Relay Ladder

Structured Text

COP(array_4[0],array_5[0],10);

Example 2:

When enabled, the COP instruction copies the structure timer_1 into element 5 of array_timer. The instruction copies only one structure to one array element.

Relay Ladder

Structured Text

COP(timer_1,array_timer[5],1);

358




Example 3:

The project_data array (100 elements) stores a variety of values that change at different times in the application. To send a complete image of project_data at one instance in time to another controller, the CPS instruction copies

project_data to produced_array.

•

While the CPS instruction copies the data, no I/O updates or other tasks can change the data.

•

The produced_array tag produces the data on a ControlNet network for consumption by other controllers.

•

To use the same image of data (that is, a synchronized copy of the data), the consuming controller (s) uses a CPS instruction to copy the data from the consumed tag to another tag for use in the application.

Relay Ladder

Structured Text

CPS(project_data[0],produced_array[0],100);

Example 4:

Local:0:I.Data stores the input data for the DeviceNet network that is connected to the 1756-DNB module in slot 0. To synchronize the inputs with the application, the CPS instruction copies the input data to input_buffer.

•

While the CPS instruction copies the data, no I/O updates can change the data.

•

As the application executes, it uses for its inputs the input data in

input_buffer.

Relay Ladder

Structured Text

CPS(Local:0:I.Data[0],input_buffer[0],20);



359


Example 5:

This example initializes an array of timer structures. When enabled, the MOV instructions initialize the .PRE and .ACC values of the first array_timer element.

When enabled, the COP instruction copies a contiguous block of bytes, starting at array_timer[0]. The length is nine timer structures.

array_timer[0] First the instruction copies timer[0] values to timer[1] array_timer[1] array_timer[2]

Then the instruction copies timer[1] values to timer[2]

Then the instruction copies timer[2] values to timer[3] array_timer[3] Then the instruction copies timer[3] values to timer[4] array_timer[4]

•

•

• array_timer[9] Finally, the instruction copies timer[9] values to timer[10] array_timer[10]

Relay Ladder

360

Structured Text

IF S:FS THEN array_timer[0].pre := 500; array_timer[0].acc := 0;

COP(array_timer[0],array_timer[1],10);

END_IF;



File Fill (FLL)


Operands:

The FLL instruction fills elements of an array with the Source value. The

Source remains unchanged.

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination

SINT

Length

INT

DINT

REAL

structure

DINT

Format:

immediate tag

Description

element to copy

Important: the Source and Destination operands should be the same data type, or unexpected results may occur tag initial element to be overwritten by the Source

Important: the Source and Destination operands should be the same data type, or unexpected results may occur

The preferred way to initialize a structure is to use the COP instruction.

immediate number of elements to fill

Structured Text

Structured text does not have an FLL instruction, but you can achieve the same results using a SIZE instruction and a FOR...DO or other loop construct.

SIZE(destination,0,length);

FOR position = 0 TO length-1 DO destination[position] := source;

END_FOR;




361


Description:

The number of bytes filled is:

Byte count = Length

∗

(number of bytes in the Destination data type)

IMPORTANT

You must test and confirm that the instruction doesn’t change data that you don’t want it to change.

The FLL instruction operates on contiguous data memory. In some cases, the instruction writes past the array into other members of the tag. This happens if the length is too big and the tag is a user-defined data type.

If the tag is

user-defined data type

NOT user-defined data type

Then

If the Length is too big, the instruction writes past the end of the array into other members of the tag. It stops at the end of the tag. No major fault is generated.

If the Length is too big, the instruction stops at the end of the array. No major fault is generated.

The Length is too big if it is more than the total number of elements in the

Destination array.

For best results, the Source and Destination should be the same type. If you want to fill a structure, use the COP instruction (see example 3 on page 359).

If you mix data types for the Source and Destination, the Destination elements are filled with converted Source values.

If The Source Is

SINT, INT, DINT, or REAL




SINT

INT

DINT

REAL

And The Destination Is The Source Is

Converted To

SINT SINT

INT

DINT

REAL structure

INT

DINT

REAL

SINT (not converted) structure structure structure

INT (not converted)

DINT (not converted)

REAL (not converted)


not affected


none

362




Execution:

Condition





end_address = start_address + (Length

∗ number of bytes in a destination element)

end_address > end of destination array yes no

end_address = end of destination array

source_address = Source postscan


end_address

yes no copy data in source_address to destination

_address


destination_address + 1 rung-condition-out is set to

true

end




363


Example:

The FLL instruction copies the value in value_1 into dest_1

Relay Ladder

Source (value_1)

Data Type

Source (value_1)

Value

SINT

DINT

SINT

REAL

SINT

16#80 (-128)

16#1234 5678

16#01

2.0

16#01

Destination

(dest_1) Data Type

DINT

SINT

REAL

INT

TIMER

Destination

(dest_1) Value

After FLL

16#FFFF FF80 (-128)

16#78

1.0

16#0002

16#0101 0101

INT

DINT

16#0001

16#0000 0001

TIMER

TIMER

16#0101 0101

16#0101 0101

16#0001 0001

16#0001 0001

16#0001 0001

16#0000 0001

16#0000 0001

16#0000 0001

Structured Text

dest_1 := value_1;

364




File Average (AVE)

Operands:

The AVE instruction calculates the average of a set of values.

Relay Ladder

Operand

Array

Dimension to vary

Type

SINT

INT

DINT

REAL

DINT

Format

array tag

Description

find the average of the values in this array specify the first element of the group of elements to average

do not use CONTROL.POS in the subscript immediate

(0, 1, 2) tag which dimension to use depending on the number of dimensions, the order is array[dim_0,dim_1,dim_2] array[dim_0,dim_1] array[dim_0] result of the operation Destination SINT

INT

Control

Length

Position

DINT

REAL

CONTROL

DINT

DINT tag control structure for the operation immediate number of elements of the array to average immediate current element in the array initial value is typically 0

Structured Text

Structured text does not have an AVE instruction, but you can achieve the same results using a SIZE instruction and a FOR...DO or other loop construct.

SIZE(array,0,length); sum := 0;

FOR position = 0 TO length-1 DO sum := sum + array[position];

END_FOR;



365


Mnemonic

.EN

.DN

.ER

.LEN

.POS

destination := sum / length;



Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the AVE instruction is enabled.

The done bit is set when the instruction has operated on the last element in the Array (.POS

= .LEN).

The error bit is set if the instruction generates an overflow. The instruction stops executing until the program clears the .ER bit. The position of the element that caused the overflow is stored in the .POS value.



Description:

The AVE instruction calculates the average of a set of values.

IMPORTANT

Make sure the Length does not cause the instruction to exceed the specified Dimension to vary. If this happens, the Destination will be incorrect.






Dimension to vary does not exist for the specified array

Fault Type

4

4

Fault Code

21

20

366




Condition


Execution:


The .EN bit is cleared.

The .DN bit is cleared.

The .ER bit is cleared.


examine .DN bit

.DN bit = 0

.DN bit = 1

.EN bit is cleared

.ER bit is cleared

.DN bit is cleared rung-condition-out is set to

false

rung-condition-in is true end postscan

The AVE instruction calculates the average by adding all the specified elements in the array and dividing by the number of elements.

Internally, the instruction uses a FAL instruction to calculate the average:

Expression = average calculation

Mode = ALL

For details on how the FAL instruction executes, see page 337.




367


Example 1:

Average array_dint, which is DINT[4,5].

dimension 0 su bs cr ipt s

0

20

1

15

0

2

10

3

5

9

4

19

14 dimension 1

1 2

18

13

17

12

3

8

3

7

2

6

1

16

11

4

AVE

=

dint_ave = 12

4

Relay Ladder

=

46

4

= 11.5

Structured Text

SIZE(array_dint,0,length); sum := 0;

FOR position = 0 TO (length-1) DO sum := sum + array_dint[position];

END_FOR; dint_ave := sum / length;

368




Example 2:

Average array_dint, which is DINT[4,5].

dimension 0 subsc rip ts

0

20

1

15

0

2

10

3

5

9

4 dimension 1

1 2

19 18

14 13

17

12

3

8

3

7

2

6

1

16

11

4

AVE

=

dint_ave = 3

5

Relay Ladder

=

15

5

= 3

Structured Text

SIZE(array_dint,1,length); sum := 0;

FOR position = 0 TO (length-1) DO sum := sum + array_dint[position];

END_FOR; dint_ave := sum / length;



369


File Sort (SRT)

The SRT instruction sorts a set of values in one dimension (Dim to vary) of the Array into ascending order.

SRT(Array,Dimtovary,

Control);

Mnemonic

.EN

.DN

.ER

.LEN

.POS

Data Type

BOOL

BOOL

BOOL

DINT

DINT

Operands:

Relay Ladder

Operand

Array

Dimension to vary

Type

SINT

INT

DINT

REAL

DINT

Control

Length

Position

CONTROL

DINT

DINT

Format

array tag

Description

array to sort specify the first element of the group of elements to sort

do not use CONTROL.POS in the subscript immediate

(0, 1, 2) which dimension to use depending on the number of dimensions, the order is array[dim_0,dim_1,dim_2] array[dim_0,dim_1] array[dim_0] tag control structure for the operation immediate number of elements of the array to sort immediate current element in the array initial value is typically 0

Structured Text

The operands are the same as those for the relay ladder SRT instruction.

However, you specify the Length and Position values by accessing the .LEN and .POS members of the CONTROL structure, rather than by including values in the operand list.


Description

The enable bit indicates that the SRT instruction is enabled.

The done bit is set when the specified elements have been sorted.

The error bit is set when either .LEN < 0 or .POS < 0. Either of these conditions also generates a major fault.

The length specifies the number of elements in the array on which the instruction


370




Description:

The SRT instruction sorts a set of values in one dimension (Dim to vary) of the Array into ascending order.

IMPORTANT

You must test and confirm that the instruction doesn’t change data that you don’t want it to change.

The SRT instruction operates on contiguous memory. In some cases, the instruction changes data in other members of the tag. This happens if the length is too big and the tag is a user-defined data type.

IMPORTANT

Make sure the Length does not cause the instruction to exceed the specified

Dimension to vary. If this happens, unexpected results will occur.


•


•

In structured text, condition the instruction so that it only executes on a transition. See Appendix C, Structured Text Programming .







Instruction tries to access data outside of the array boundaries

Fault Type

4

4

4

Fault Code

21

20

20



371


Condition


Execution:






examine .DN bit

.DN bit = 0

.DN bit = 1

.EN bit is cleared

.ER bit is cleared

.DN bit is cleared





na rung-condition-out is set to

false


EnableIn is set instruction execution postscan end



na na

The instruction sorts the specified elements of the array into ascending order.




The instruction sorts the specified elements of the array into ascending order.

No action taken.

372




Example 1:

Sort int _array, which is DINT[4,5].

Before

dimension 0 subs cripts

0 20

1

15

0

2

10

3

5

9

4 dimension 1

1 2

19

14

18

13

17

12

3

8

3

7

2

6

1

16

11

4

After

dimension 0 sub scr ipt s

0 20

1

15

0

2

10

3

5

9

4 dimension 1

1 2

19

14

3

8

17

12

3

13

18

7

2

6

1

16

11

4

Relay Ladder

Structured Text

control_1.LEN := 4; control_1.POS := 0;

SRT(int_array[0,2],0,control_1);



373


Example 2:

Sort int _array, which is DINT[4,5].

Before

dimension 0 su bscr ipts

0 20

1

15

0

2

10

3

5

9

4

19

14 dimension 1

1 2

18

13

17

12

3

8

3

7

2

6

1

16

11

4

After

dimension 0 subs cript s

0

20

1

15

0

2

6

3

5

7

4

19

14 dimension 1

1 2

18

13

17

12

3

8

3

9

2

10

1

16

11

4

Relay Ladder

Structured Text

control_1.LEN := 5; control_1.POS := 0;

SRT(int_array[2,0],1,control_1);

374




File Standard Deviation

(STD)

Operands:

The STD instruction calculates the standard deviation of a set of values in one dimension of the Array and stores the result in the Destination.

Relay Ladder

Operand

Array

Dimension to vary

Position

Type

SINT

Format

array tag

Description

find the standard deviation of the values in this array

INT

DINT

specify the first element of the group of elements to use in calculating the standard deviation

REAL

do not use CONTROL.POS in the subscript


DINT immediate which dimension to use

(0, 1, 2) depending on the number of dimensions, the order is array[dim_0,dim_1,dim_2] array[dim_0,dim_1]

Destination REAL

Control

Length

CONTROL

DINT

DINT tag tag array[dim_0] result of the operation control structure for the operation immediate number of elements of the array to use in calculating the standard deviation immediate current element in the array initial value is typically 0


Mnemonic

.EN

.DN

.ER

.LEN

.POS

Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the STD instruction is enabled.

The done bit is set when the calculation is complete.

The error bit is set when the instruction generates an overflow. The instruction stops executing until the program clears the .ER bit. The position of the element that caused the overflow is stored in the .POS value.





375


Structured Text

Structured text does not have an STD instruction, but you can achieve the same results using a SIZE instruction and a FOR...DO or other loop construct.

SIZE(array,0,length); sum := 0;

FOR position = 0 TO length-1 DO sum := sum + array[position];

END_FOR; average := sum / length; sum := 0;

FOR position = 0 TO length-1 DO sum := sum + ((array[position] - average)**2);

END_FOR; destination := SQRT(sum /(length-1));


Description:

The standard deviation is calculated according to this formula:

Standard Deviation =

N

∑

[ ⟨

i

= 1

X

(

(

)

–

AVE

⟩

2

]

⎠

)

Where:

• start = dimension-to-vary subscript of the array operand

• x i

= variable element in the array

•

N = number of specified elements in the array

•

AVE =

⎛

⎜

⎜

⎝

N

∑

x

( )

⎠

⎟

⎟

⎞

-----------------------------------------

N

IMPORTANT

Make sure the Length does not cause the instruction to exceed the specified

Dimension to vary. If this happens, the Destination will be incorrect.

376










Fault Type

4

4

Fault Code

21

20



377


Condition


Execution:






examine .DN bit

.DN bit = 0

.DN bit = 1

.EN bit is cleared

.ER bit is cleared

.DN bit is cleared rung-condition-out is set to

false

end rung-condition-in is true postscan

The STD instruction calculates the standard deviation of the specified elements.

Internally, the instruction uses a FAL instruction to calculate the average:

Expression = standard deviation calculation

Mode = ALL

For details on how the FAL instruction executes, see page 337.


378




AVE

=

4

Example 1:

Calculate the standard deviation of dint_array, which is DINT[4,5].

dimension 1 subsc ripts

0 1 2 3 dimension 0

0 20

1

15

19

14

18

13

17

12

=

34

4

= 8.5

2

10

3

5

9

4

8

3

7

2

6

1

16

11

4

STD

=

⟨

16 8.5

⟩

2

+

⟨

⟨

⟩

2

+

4 1

⟨

⟩

⟩

2

+

⟨

1 8.5

⟩

2

= 6.454972

real_std = 6.454972

Relay Ladder

Structured Text

SIZE(dint_array,0,length); sum := 0;

FOR position = 0 TO (length-1) DO sum := sum + dint_array[position];


FOR position = 0 TO (length-1) DO sum := sum + ((dint_array[position] - average)**2);

END_FOR; real_std := SQRT(sum / (length-1));



379


AVE

=

5

Example 2:

Calculate the standard deviation of dint_array, which is DINT[4,5].

dimension 1 subs crip ts

0 1 2 3

19 18 17

0

20

1

15 dimension 0

14 13 12

2

10 9 8 7

=

90

5

= 18

3

5 4 3 2

6

16

11

4

1

STD

=

⟨

20 18

⟩

2

+

⟨

19 18

⟩

2

+

⟨

⟨

18 18

5 1

⟩

⟩

2

+

⟨

17 18

⟩

2

+

⟨

16 18

⟩

2

= 1.581139

real_std = 1.581139

Relay Ladder

Structured Text

SIZE(dint_array,1,length); sum := 0;

FOR position = 0 TO (length-1) DO sum := sum + dint_array[position];


FOR position = 0 TO (length-1) DO sum := sum + ((dint_array[position] - average)**2);

END_FOR; real_std := SQRT(sum / (length-1));

380




Size In Elements (SIZE)

Operands:

The SIZE instruction finds the size of a dimension of an array.

Relay Ladder

Operand

Source

Dimension to Vary

Type

SINT

INT

DINT

REAL structure string

DINT

Format

array tag

Description

array on which the instruction is to operate

Size immediate

(0, 1, 2) dimension to use: tag

For The Size Of

first dimension second dimension third dimension

Enter

0

1

2 tag to store the number of elements in the specified dimension of the array

SINT

INT

DINT

REAL

Structured Text

SIZE(Source,Dimtovary,Size);

The operands are the same as those for the relay ladder SIZE instruction.

Description:

The SIZE instruction finds the number of elements (size) in the designated dimension of the Source array and places the result in the Size operand.

•

The instruction finds the size of one dimension of an array.

•

The instruction operates on an:

–

array

–

array in a structure

–

array that is part of a larger array


not affected


none.



381


Execution:

Condition


EnableIn is set








No action taken.

na na

The instruction finds the size of a dimension.




The instruction finds the size of a dimension.

No action taken.

Example 1:

Find the number of elements in dimension 0 (first dimension) of array_a. Store the size in array_a_size. In this example, dimension 0 of array_a has 10 elements.

Relay Ladder

SIZE

Size in Elements

Source array_a[0]

Dim. To Vary

Size

255

0 array_a_size

10

382

Structured Text

SIZE(array_a,0,array_a_size);

Example 2:

Find the number of elements in the DATA member of string_1, which is a string. Store the size in string_1_size. In this example, the DATA member of

string_1 has 82 elements. (The string uses the default STRING data type.) Since each element holds one character, string_1 can contain up to 82 characters.

Relay Ladder

SIZE

Size in Elements

Source string_1.DATA[0]

'$00'

Dim. To Vary

Size

0 string_1_size

82

Structured Text

SIZE(string_1.DATA[0],0,string_1_size);




Example 3:

Strings_a is an array of string structures. The SIZE instruction finds the number of elements in the DATA member of the string structure and stores the size in data_size_a. In this example, the DATA member has 24 elements.

(The string structure has a user-specified length of 24.)

Relay Ladder

SIZE

Size in Elements

Source strings_a[0].DATA[0]

'$00'

Dim. To Vary

Size

0 data_size_a

24

Structured Text

SIZE(strings_a[0].DATA[0],0,data_size_a);



383


Notes:

384



Chapter

9

Array (File)/Shift Instructions

(BSL, BSR, FFL, FFU, LFL, LFU)

Introduction

Use the array (file)/shift instructions to modify the location of data within arrays.

If You Want To

Load bits into, shift bits through, and unload bits from a bit array one bit at a time.

Load and unload values in the same order.

Load and unload values in reverse order.


BSL

BSR

FFL

FFU

LFL

LFU


relay ladder relay ladder relay ladder relay ladder relay ladder relay ladder

See Page

386

390

394

400

406

412

You can mix data types, but loss of accuracy and rounding errors might occur.




385

Chapter 9 Array (File)/Shift Instructions (BSL, BSR, FFL, FFU, LFL, LFU)

Bit Shift Left (BSL)

Mnemonic

.EN

.DN

.UL

.ER

.LEN

The BSL instruction shifts the specified bits within the Array one position left.

Operands:

Relay Ladder

Operand

Array

Type

DINT

Control CONTROL

Source bit BOOL

Length DINT

Format

array tag

Description

array to modify specify the first element of the group of elements tag

do not use CONTROL.POS in the subscript control structure for the operation tag bit to shift immediate number of bits in the array to shift


Data Type

BOOL

BOOL

BOOL

BOOL

DINT

Description

The enable bit indicates that the BSL instruction is enabled.

The done bit is set to indicate that bits shifted one position to the left.

The unload bit is the instruction’s output. The .UL bit stores the status of the bit that was shifted out of the range of bits.

The error bit is set when .LEN < 0.

The length specifies the number of array bits to shift.

Description:

When enabled, the instruction unloads the uppermost bit of the specified bits to the .UL bit, shifts the remaining bits one position left, and loads Source bit into bit 0 of Array.

IMPORTANT


The BSL instruction operates on contiguous memory. In some cases, the instruction shifts bits past the array into other members of the tag. This happens if the length is too big and the tag is a user-defined data type.


not affected


none

386



Array (File)/Shift Instructions (BSL, BSR, FFL, FFU, LFL, LFU) Chapter 9

Condition:

prescan

Execution:






The .POS value is cleared.









387


Condition:



examine .EN bit

.EN bit = 1

.EN bit is set

.EN bit = 0

.LEN = 0 no yes

.LEN < 0 yes no shift array left one position left

.UL bit array source bit

.ER bit is set postscan

.DN bit is set

.DN bit is set examine source bit

.source bit = 1

.UL bit remains set

.UL bit is set

.source bit = 0 rung-condition-out is set to

true

end


388




Example 1:

When enabled, the BSL instruction starts at bit 0 in array_dint[0]. The instruction unloads array_dint[0].9 into the .UL bit, shifts the remaining bits, and loads input_1 into array_dint[0].0. The values in the remaining bits (10-31) are invalid.

array_dint[0]

before shift

9 8 7 6 5 4 3 2 1 0

1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 these bits shift left

0

.UL bit

array_dint[0]

after shift

9 8 7 6 5 4 3 2 1 0

0 1 1 1 1 0 0 0 0 1

1

input_1

Example 2:

When enabled, the BSL instruction starts at bit 0 in array_dint[0]. The instruction unloads array_dint[1].25 into the .UL bit, shifts the remaining bits, and loads input_1 into array_dint[0].0. The values in the remaining bits (31-26 in

array_dint[1]) are invalid. Note how array_dint[0].31 shifts across words to

array_dint[1].0.

31 0

array_dint[0] 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0

array_dint[1]

31 these bits shift left

0

0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0

1

input_1

these bits shift left

0

.UL bit



389


Bit Shift Right (BSR)

Mnemonic

.EN

.DN

.UL

.ER

.LEN

The BSR instruction shifts the specified bits within the Array one position right.

Operands:

Relay Ladder

Operand

Array

Type

DINT

Control CONTROL

Source bit BOOL

Length DINT

Format

array tag

Description

array to modify specify the element where to begin the shift

do not use CONTROL.POS in the subscript tag tag control structure for the operation bit to shift immediate number of bits in the array to shift


Data Type

BOOL

BOOL

BOOL

BOOL

DINT

Description

The enable bit indicates that the BSR instruction is enabled.

The done bit is set to indicate that bits shifted one position to the right.

The unload bit is the instruction’s output. The .UL bit stores the status of the bit that was shifted out of the range of bits.

The error bit is set when .LEN < 0.

The length specifies the number of array bits to shift.

Description:

When enabled, the instruction unloads the value at bit 0 of Array to the .UL bit, shifts the remaining bits one position right, and loads Source bit into the uppermost bit of the specified bits.

IMPORTANT


The BSR instruction operates on contiguous memory. In some cases, the instruction changes bits in other members of the tag. This happens if the length is too big and the tag is a user-defined data type.


not affected


none

390



Execution:

Condition
















391


Condition



examine .EN bit

.EN bit = 1

.EN bit is set

.EN bit = 0

.LEN = 0 no yes

.LEN < 0 yes no shift array left one position left source bit array

.UL bit

.ER bit is set postscan

.DN bit is set

.DN bit is set examine source bit

.source bit = 1

.UL bit remains set

.UL bit is set

.source bit = 0 rung-condition-out is set to

true

end


392




Example 1:

When enabled, the BSR instruction starts at bit 9 in array_dint[0]. The instruction unloads array_dint[0].0 into the .UL bit, shifts the remaining bits right, and loads input_1 into array_dint[0].9. The values in the remaining bits

(10-31) are invalid.

array_dint[0]

before shift

9 8 7 6 5 4 3 2 1 0

1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 these bits shift right

1

input_1 array_dint[0]

after shift

9 8 7 6 5 4 3 2 1 0

1 0 0 1 1 1 1 0 0 0

0

.UL bit

Example 2:

When enabled, the BSR instruction starts at bit 25 in array_dint[1]. The instruction unloads array_dint[0].0 into the .UL bit, shifts the remaining bits right, and loads input_1 into array_dint[1].25. The values in the remaining bits

(31-26 in dint_array[1]) are invalid. Note how array_dint[1].0 shifts across words into array_dint[0].31.

31 0

array_dint[0] 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 these bits shift right

0

.UL bit

array_dint[1]

31 0

0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 0 0 0 0 these bits shift right

1

input_1



393


FIFO Load (FFL)

The FFL instruction copies the Source value to the FIFO.

Operands:

Relay Ladder

Operand

Source

FIFO

Control

Length

Position

Type

SINT

INT

DINT

Format

immediate tag

Description

data to be stored in the FIFO

REAL string structure

The Source converts to the data type of the array tag. A smaller integer converts to a larger integer by sign-extension.

SINT array tag FIFO to modify specify the first element of the FIFO


INT

DINT


CONTROL

DINT

DINT tag control structure for the operation typically use the same CONTROL as the associated FFU immediate maximum number of elements the FIFO can hold at one time immediate next location in the FIFO where the instruction loads data initial value is typically 0

If you use a user-defined structure as the data type for the Source or FIFO operand, use the same structure for both operands.

394




Mnemonic

.EN

.DN

.EM

.LEN

.POS


Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the FFL instruction is enabled.

The done bit is set to indicate that the FIFO is full (.POS = .LEN). The .DN bit inhibits loading the FIFO until .POS < .LEN.

The empty bit indicates that the FIFO is empty. If .LEN

≤

.DN bit are set.

The length specifies the maximum number of elements the FIFO can hold at one time.

The position identifies the location in the FIFO where the instruction will load the next value.

Description:

Use the FFL instruction with the FFU instruction to store and retrieve data in a first-in/first-out order. When used in pairs, the FFL and FFU instructions establish an asynchronous shift register.

Typically, the Source and the FIFO are the same data type.

When enabled, the FFL instruction loads the Source value into the position in the FIFO identified by the .POS value. The instruction loads one value each time the instruction is enabled, until the FIFO is full.

IMPORTANT


The FFL instruction operates on contiguous memory. In some cases, the instruction loads data past the array into other members of the tag. This happens if the length is too big and the tag is a user-defined data type.


not affected



(starting element + .POS) > FIFO array size

Fault Type

4

Fault Code

20



395


Condition

prescan

.EN bit is set to prevent a false load when scan begins

Execution:


.LEN < 0 no yes

.POS < 0

.EM is cleared no yes

.EM is set

.POS = 0 no yes

.EM is set

.POS

≥

.LEN

yes no

.DN is set rung-condition-out is set to

false

end

396



Condition


.EN bit is cleared

.LEN < 0 no yes

.POS < 0




.EM is set

.POS = 0 no yes

.EM is set

.POS

≥

.LEN

yes no


false

end



397



rung-condition-in is true examine .EN bit

.EN = 0

.EN = 1

.LEN < 0 no yes

.POS < 0 yes no

.EM bit is cleared

.EN bit is set

.EM bit is set

.LEN < 0 yes no

.POS < 0 yes no

.EM bit is cleared

.DN is cleared

.POS = 0 no yes

.EM bit is set

.POS

≥

.LEN

yes no

.DN bit is set

.POS

≥

.LEN

yes no

.DN bit is set

.POS or

.LEN > size of array yes no major fault

.POS > .LEN

yes no

.POS = .POS - 1

FIFO[.POS - 1] = source

.EM bit is set rung-condition-out is set to

true

end


postscan

398




Example:

When enabled, the FFL instruction loads value_1 into the next position in the

FIFO, which is array_dint[5] in this example.

array_dint[0] array_dint[5]

before FIFO load

00000

11111

22222

33333

44444

00000

00000

00000

00000

00000

control_1.pos = 5

value_1 = 55555 after FIFO load

00000

11111

22222

33333

44444

55555

00000

00000

00000

00000

control_1.pos = 6



399


FIFO Unload (FFU)

Operands:

The FFU instruction unloads the value from position 0 (first position) of the

FIFO and stores that value in the Destination. The remaining data in the

FIFO shifts down one position.

Relay Ladder

Operand

FIFO

Type

SINT

INT

DINT


Destination SINT

Control

Length

Position

Format

array tag

tag

Description

FIFO to modify specify the first element of the FIFO

do not use CONTROL.POS in the subscript value that exits the FIFO

INT

DINT


The Destination value converts to the data type of the Destination tag. A smaller integer converts to a larger integer by sign-extension.

CONTROL tag control structure for the operation

DINT

DINT typically use the same CONTROL as the associated FFL immediate maximum number of elements the FIFO can hold at one time immediate next location in the FIFO where the instruction unloads data initial value is typically 0

If you use a user-defined structure as the data type for the FIFO or

Destination operand, use the same structure for both operands.

400




Mnemonic

.EU

.DN

.EM

.LEN

.POS


Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable unload bit indicates that the FFU instruction is enabled. The .EU bit is set to preset a false unload when the program scan begins.

The done bit is set to indicate that the FIFO is full (.POS = .LEN).

The empty bit indicates that the FIFO is empty. If .LEN

≤ bits are set.

The length specifies the maximum number of elements in the FIFO.

The position identifies the end of the data that has been loaded into the FIFO.

Description:

Use the FFU instruction with the FFL instruction to store and retrieve data in a first-in/first-out order.

When enabled, the FFU instruction unloads data from the first element of the

FIFO and places that value in the Destination. The instruction unloads one value each time the instruction is enabled, until the FIFO is empty. If the

FIFO is empty, the FFU returns 0 to the Destination.

IMPORTANT


The FFU instruction operates on contiguous memory. In some cases, the instruction unloads data from other members of the tag. This happens if the length is too big and the tag is a user-defined data type.


not affected



Length > FIFO array size

Fault Type

4

Fault Code

20



401


Execution:

Condition

prescan

.EU bit is set to prevent a false unload when scan begins


.LEN < 0 no yes

.POS < 0


.EM is set

.POS = 0 no yes

.EM is set

.POS

≥

.LEN

yes no


false

end

402



Condition


.EU bit is cleared

.LEN < 0 no yes

.POS < 0




.EM is set

.POS = 0 no yes

.EM is set

.POS

≥

.LEN

yes no


false

end



403


Condition

rung-condition-in is true examine .EU bit

.EU = 0

.EU = 1

.LEN < 0 no yes

.POS < 0 yes no

.EM bit is cleared

.POS = 0 no yes

.EM bit is set

.POS

≥

.LEN

yes no

.DN bit is set

.EU bit is set


.EM bit is set

.LEN < 0 yes no

.POS < 0 yes no

.EM bit is cleared


.POS

≤ no yes

.EM bit is set

.POS < 1 no

.POS = .POS -1

Destination = FIFO[0] yes

Destination = 0

FIFO[i - 1] = FIFO[i]

.EM bit is set postscan

404

i < .LEN

no yes rung-condition-out is set to

true

end





Example:

When enabled, the FFU instruction unloads array_dint[0] into value_2 and shifts the remaining elements in array_dint.


before FIFO unload

00000

11111

22222

33333

44444

55555

00000

00000

00000

00000

control_1.pos = 6 after FIFO unload

11111

22222

33333

44444

55555

00000

00000

00000

00000

00000

control_1.pos = 5

value_2 = 00000



405


LIFO Load (LFL)

The LFL instruction copies the Source value to the LIFO.

Operands:

Relay Ladder

Operand

Source

LIFO

Control

Length

Position

Type

SINT

INT

DINT

Format

immediate tag

Description

data to be stored in the LIFO

REAL string structure

The Source converts to the data type of the array tag. A smaller integer converts to a larger integer by sign-extension.

SINT

array tag LIFO to modify specify the first element of the LIFO


INT

DINT

REAL string structure

CONTROL

DINT

DINT tag control structure for the operation typically use the same CONTROL as the associated LFU immediate maximum number of elements the LIFO can hold at one time immediate next location in the LIFO where the instruction loads data initial value is typically 0

If you use a user-defined structure as the data type for the Source or LIFO operand, use the same structure for both operands.

406




Mnemonic

.EN

.DN

.EM

.LEN

.POS


Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description:

The enable bit indicates that the LFL instruction is enabled.

The done bit is set to indicate that the LIFO is full (.POS = .LEN). The .DN bit inhibits loading the LIFO until .POS < .LEN.

The empty bit indicates that the LIFO is empty. If .LEN

≤

.DN bit are set.

The length specifies the maximum number of elements the LIFO can hold at one time.

The position identifies the location in the LIFO where the instruction will load the next value.

Description:

Use the LFL instruction with the LFU instruction to store and retrieve data in a last-in/first-out order. When used in pairs, the LFL and LFU instructions establish an asynchronous shift register.

Typically, the Source and the LIFO are the same data type.

When enabled, the LFL instruction loads the Source value into the position in the LIFO identified by the .POS value. The instruction loads one value each time the instruction is enabled, until the LIFO is full.

IMPORTANT


The LFL instruction operates on contiguous memory. In some cases, the instruction loads data past the array into other members of the tag. This happens if the length is too big and the tag is a user-defined data type.


not affected



(starting element + .POS) > LIFO array size

Fault Type

4

Fault Code

20



407


Condition:

prescan

.EN bit is set to prevent a false load when scan begins

Execution:


.LEN < 0 no yes

.POS < 0


.EM is set

.POS = 0 no yes

.EM is set

.POS

≥

.LEN

yes no


false

end

408



Condition:


.EN bit is cleared

.LEN < 0 no yes

.POS < 0




.EM is set

.POS = 0 no yes

.EM is set

.POS

≥

.LEN

yes no


false

end



409


Relay Ladder Action Condition:

rung-condition-in is true examine .EN bit

.EN = 0

.EN = 1

.LEN < 0 no yes

.POS < 0 yes no

.EM bit is cleared

.EN bit is set

.EM bit is set

.LEN < 0 yes no

.POS < 0 yes no

.EM bit is cleared

.DN is cleared

.POS = 0 no yes

.EM bit is set

.POS

≥

.LEN

yes no

.DN bit is set

.POS

≥

.LEN

yes no

.DN bit is set

.POS or


.POS > .LEN

yes no

.POS = .POS - 1

LIFO[.POS - 1] = source

.EM bit is set rung-condition-out is set to

true

end


postscan

410




Example:

When enabled, the LFL instruction loads value_1 into the next position in the

LIFO, which is array_dint[5] in this example.


before LIFO load

00000

11111

22222

33333

44444

00000

00000

00000

00000

00000

control_1.pos = 5

value_1 = 55555 after LIFO load

00000

11111

22222

33333

44444

55555

00000

00000

00000

00000

control_1.pos = 6



411


LIFO Unload (LFU)

Operands:

The LFU instruction unloads the value at .POS of the LIFO and stores 0 in that location.

Relay Ladder

Operand

LIFO

Type

SINT

INT

DINT


Destination SINT

Control

Length

Position

Format

array tag

tag

Description

LIFO to modify specify the first element of the LIFO

do not use CONTROL.POS in the subscript value that exits the LIFO

INT

DINT


The Destination value converts to the data type of the Destination tag. A smaller integer converts to a larger integer by sign-extension.


DINT

DINT typically use the same CONTROL as the associated LFL immediate maximum number of elements the LIFO can hold at one time immediate next location in the LIFO where the instruction unloads data initial value is typically 0

If you use a user-defined structure as the data type for the LIFO or

Destination operand, use the same structure for both operands.

412




Mnemonic

.EU

.DN

.EM

.LEN

.POS


Data Type:

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable unload bit indicates that the LFU instruction is enabled. The .EU bit is set to preset a false unload when the program scan begins.

The done bit is set to indicate that the LIFO is full (.POS = .LEN).

The empty bit indicates that the LIFO is empty. If .LEN

≤

.DN bit are set.

The length specifies the maximum number of elements the LIFO can hold at one time.

The position identifies the end of the data that has been loaded into the LIFO.

Description:

Use the LFU instruction with the LFL instruction to store and retrieve data in a last-in/first-out order.

When enabled, the LFU instruction unloads the value at .POS of the LIFO and places that value in the Destination. The instruction unloads one value and replaces it with 0 each time the instruction is enabled, until the LIFO is empty.

If the LIFO is empty, the LFU returns 0 to the Destination.

IMPORTANT


The LFU instruction operates on contiguous memory. In some cases, the instruction unloads data from other members of the tag. This happens if the length is too big and the tag is a user-defined data type.


not affected



Length > LIFO array size

Fault Type

4

Fault Code

20



413


Execution:

Condition

prescan

.EU bit is set to prevent a false unload when scan begins

Relay Ladder Action:

.LEN < 0 no yes

.POS < 0


.EM is set

.POS = 0 no yes

.EM is set

.POS

≥

.LEN

yes no


false

end

414



Condition


.EU bit is cleared

.LEN < 0 no yes

.POS < 0




.EM is set

.POS = 0 no yes

.EM is set

.POS

≥

.LEN

yes no


false

end



415


Condition

rung-condition-in is true examine .EU bit

.EU = 0

.EU = 1

.LEN < 0 no yes

.POS < 0 yes no

.EM bit is cleared

.EU bit is set


.LEN < 0 yes no

.POS < 0 yes no

.EM bit is cleared

.POS = 0 no yes

.EM bit is set

.POS

≥

.LEN

yes no

.DN bit is set

.EM bit is set

.POS

≤ no yes

.EM bit is set

.POS < 1 yes no

Destination = 0

.POS

> .

LEN yes no

.POS = .POS -1

.POS = .LEN

.LEN > size of array yes no

Destination = LIFO[control.POS] major fault

.EM bit is set postscan

416


true

end





Example:

When enabled, the LFU instruction unloads array_dint[5] into value_2.


before LIFO unload

00000

11111

22222

33333

44444

55555

00000

00000

00000

00000

control_1.pos = 6 after LIFO unload

00000

11111

22222

33333

44444

00000

00000

00000

00000

00000

control_1.pos = 5

value_2 = 55555



417


Notes:

418



Chapter

10

Sequencer Instructions

(SQI, SQO, SQL)

Introduction

If You Want To

Detect when a step is complete.

Set output conditions for the next step.

Load reference conditions into sequencer arrays

No action taken.Sequencer instructions monitor consistent and repeatable operations.


SQI

SQO

SQL


relay ladder relay ladder relay ladder

See Page

420

424

428




419

Chapter 10 Sequencer Instructions (SQI, SQO, SQL)

Sequencer Input (SQI)

Mnemonic

.ER

.LEN

.POS

The SQI instruction detects when a step is complete in a sequence pair of

SQO/SQI instructions.

Operands:

Data Type

BOOL

DINT

DINT

Relay Ladder

Operand

Array

Mask

Source

Type

DINT

Format

array tag

Description

sequencer array specify the first element of the sequencer array

do not use CONTROL.POS in the subscript which bits to block or pass SINT

INT tag immediate

DINT


SINT tag input data for the sequencer array

INT

Control

Length

Position

DINT



DINT

DINT typically use the same CONTROL as the SQO and SQL instructions immediate number of elements in the Array (sequencer table) to compare immediate current position in the array initial value is typically 0


Description

The error bit is set when .LEN

≤

The length specifies the number of steps in the sequencer array.

The position identifies the element that the instruction is currently comparing.

420



Sequencer Instructions (SQI, SQO, SQL) Chapter 10

Description:

When enabled, the SQI instruction compares a Source element through a

Mask to an Array element for equality.

Typically use the same CONTROL structure as the SQO and

SQL instructions.

The SQI instruction operates on contiguous memory.

Enter an Immediate Mask Value



Prefix:

16#

8#

2#

Description



not affected


none



421


Execution:

Condition:





.LEN

≤

0

.POS < 0 or

.POS > .LEN

yes

.ER bit is set no

.ER bit is cleared rung-condition-out is set to

false

no masked Source = masked Array[.POS] yes rung-condition-out is set to

true

postscan end


422




Example:

When enabled, the SQI instruction passes value_2 through the mask to determine whether the result is equal to the current element in array_dint. The masked comparison is true, so the rung-condition-out goes true.

SQI Operand

Source

Mask

Array

Example Values (DINTs Displayed In Binary) xxxxxxxx xxxxxxxx xxxx0101 xxxx1010

00000000 00000000 00001111 00001111 xxxxxxxx xxxxxxxx xxxx0101 xxxx1010

A 0 in the mask means the bit is not compared (designated by xxxx in this example).

Use SQI without SQO

If you use the SQI instruction without a paired SQO instruction, you have to externally increment the sequencer array.

The SQI instruction compares the source value. The ADD instruction increments the sequencer array. The GRT determined whether another value is available to check in the sequencer array. The MOV instruction resets the position value after completely stepping through the sequencer array one time.



423


Sequencer Output (SQO)

The SQO instruction sets output conditions for the next step of a sequence pair of SQO/SQI instructions.

Operands:

Relay Ladder

Operand

Array

Length

Position

Type

DINT

DINT

DINT

Format

array tag

Description


Mask SINT

INT tag immediate

do not use CONTROL.POS in the subscript which bits to block or pass

DINT


Destination DINT tag output data from the sequencer array

Control CONTROL tag control structure for the operation typically use the same CONTROL as the SQI and SQL instructions immediate number of elements in the Array (sequencer table) to output immediate current position in the array initial value is typically 0


Mnemonic

.EN

.DN

.ER

.LEN

.POS

Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the SQO instruction is enabled.

The done bit is set when all the specified elements have been moved to the Destination.


≤


The position identifies the element that the controller is currently manipulating.

424




Description:

When enabled, the SQO instruction increments the position, moves the data at the position through the Mask, and stores the result in the Destination. If

.POS > .LEN, the instruction wraps around to the beginning of the sequencer array and continues with .POS = 1.

Typically, use the same CONTROL structure as the SQI and SQL instructions.

The SQO instruction operates on contiguous memory.

Condition

prescan

Enter an Immediate Mask Value



Prefix

16#

8#

2#

Description



not affected


none

Execution:



The .EN bit is set to prevent a false load when the program scan begins.






425


Condition



.LEN

≤

.POS < 0 no yes

.POS = .LEN

no yes

.DN bit is set examine .EN bit

.EN = 0

.EN = 1

.EN bit is set

.ER bit is cleared

.POS

≥

.LEN

yes no

.POS = .POS + 1

.POS value rolls over no yes goto error

.POS = 1

.POS = .LEN

yes no

.POS > .LEN

no yes

.DN bit is set error

.ER bit is set

Destination = (Destination AND (NOT(Mask)))

OR (Array[control.POS] AND Mask)



true

end postscan

426




Example:

When enabled, the SQO instruction increments the position, passes the data at that position in array_dint through the mask, and stores the result in value_1.

SQO Operand

Array

Mask

Destination

Example Values (Using INTS Displayed In Binary) xxxxxxxx xxxxxxxx xxxx0101 xxxx1010

00000000 00000000 00001111 00001111 xxxxxxxx xxxxxxxx xxxx0101 xxxx1010

A 0 in the mask means the bit is not compared (designated by xxxx in this example).

Using SQI with SQO

If you pair an SQI instruction with an SQO instruction, make sure that both instructions use the same Control, Length, and Position values,.

Resetting the position of SQO

Each time the controller goes from Program to Run mode, the SQO instruction clears (initializes) the .POS value. To reset .POS to the initialization value (.POS = 0), use a RES instruction to clear the position value. This example uses the status of the first-scan bit to clear the .POS value.



427


Sequencer Load (SQL)

Operands:

The SQL instruction loads reference conditions into a sequencer array.

Relay Ladder

Operand

Array

Source

Control

Length

Position

Type

DINT

DINT

DINT

Format

array tag immediate immediate

Description


SINT

INT tag immediate

do not use CONTROL.POS in the subscript input data to load into the sequencer array

DINT


CONTROL tag control structure for the operation typically use the same CONTROL as the SQI and SQO instructions number of elements in the Array (sequencer table) to load current position in the array initial value is typically 0


Mnemonic

.EN

.DN

.ER

.LEN

.POS

Data Type

BOOL

BOOL

BOOL

DINT

DINT

Description

The enable bit indicates that the SQL instruction is enabled.

The done bit is set when all the specified elements have been loaded into Array.


≤


The position identifies the element that the controller is currently manipulating.

428




Description:

When enabled, the SQL instruction increments to the next position in the sequencer array and loads the Source value into that position. If the .DN bit is set or if .POS

≥

.LEN, the instruction sets .POS=1.

Typically use the same CONTROL structure as the SQI and

SQO instructions.

IMPORTANT


The SQL instruction operates on contiguous memory. In some cases, the instruction loads data past the array into other members of the tag. This happens if the length is too big and the tag is a user-defined data type.

Condition

prescan


not affected



Length > size of Array 4

Execution:


Fault Code

20


The .EN bit is set to prevent a false load when the program scan begins.






429


Condition



.LEN

≤

.POS < 0 no yes

.POS = .LEN

no yes

.DN bit is set examine .EN bit

.EN = 0

.EN = 1

.EN bit is set

.ER bit is cleared

.POS

≥

.LEN

yes no

.POS = .POS + 1

.POS value rolls over no yes

.POS = 1 goto error error

.ER bit is set

.POS = .LEN

yes no

.POS > .LEN

no yes

.DN bit is set

.LEN > size of array yes no

Array[control.POS] = Source major fault



true

end postscan

430




Example:

When enabled, the SQL instruction loads value_3 into the next position in the sequencer array, which is array_dint[5] in this example.


before load

00000

11111

22222

33333

44444

00000

00000

00000

00000

00000

control_1.pos = 5

value_3 = 55555 after load

00000

11111

22222

33333

44444

55555

00000

00000

00000

00000

control_1.pos = 6



431


Notes:

432



Chapter

11

Program Control Instructions

(JMP, LBL, JSR, RET, SBR, JXR, TND, MCR, UID, UIE, AFI,

NOP, EOT, SFP, SFR, EVENT)

Introduction

Enable user tasks.

Disable a rung.

Insert a placeholder in the logic.

End a transition for a sequential function chart.

Pause a sequential function chart.

Reset a sequential function chart.

Trigger the execution of an event task

Use the program control instructions to change the flow of logic.

If You Want To

Jump over a section of logic that does not always need to be executed.

Jump to a separate routine, pass data to the routine, execute the routine, and return results.


JMP

LBL

JSR

SBR

RET

Jump to an external routine (SoftLogix5800 controller only)

Mark a temporary end that halts routine execution.

Disable all the rungs in a section of logic.

Disable user tasks.

JXR

TND

MCR

UID

UIE

AFI

NOP

EOT

SFP

SFR

EVENT


relay ladder relay ladder function block structured text relay ladder relay ladder structured text relay ladder relay ladder structured text relay ladder structured text relay ladder relay ladder relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text

See Page

434

436

447

450

452

454

454

456

457

458

460

462

464



433

Chapter 11 Program Control Instructions (JMP, LBL, JSR, RET, SBR, JXR, TND, MCR, UID, UIE, AFI, NOP, EOT, SFP, SFR, EVENT)

Jump to Label (JMP)

Label (LBL)

Operands:

The JMP and LBL instructions skip portions of ladder logic.

Relay Ladder

Operand Type

JMP instruction

Label name

LBL instruction

Label name


label name enter name for associated LBL instruction label name execution jumps to LBL instruction with referenced label name

Description:

When enabled, the JMP instruction skips to the referenced LBL instruction and the controller continues executing from there. When disabled, the JMP instruction does not affect ladder execution.

The JMP instruction can move ladder execution forward or backward.

Jumping forward to a label saves program scan time by omitting a logic segment until it’s needed. Jumping backward lets the controller repeat iterations of logic.

Be careful not to jump backward an excessive number of times. The watchdog timer could time out because the controller never reaches the end of the logic, which in turn faults the controller.

ATTENTION

Jumped logic is not scanned. Place critical logic outside the jumped zone.

The LBL instruction is the target of the JMP instruction that has the same label name. Make sure the LBL instruction is the first instruction on its

rung.

A label name must be unique within a routine. The name can:

• have as many as 40 characters

• contain letters, numbers, and underscores (_)

434



Program Control Instructions (JMP, LBL, JSR, RET, SBR, JXR, TND, MCR, UID, UIE, AFI, NOP, EOT, SFP, SFR, EVENT) Chapter 11

Condition:



not affected



label does not exist 4

Execution:

Fault Code

42





Execution jumps to the rung that contains the LBL instruction with the referenced label name.


Example:

When the JMP instruction is enabled, execution jumps over successive rungs of logic until it reaches the rung that contains the LBL instruction with

label_20.

[other rungs of code]



435


Jump to Subroutine (JSR)

Subroutine (SBR) Return

(RET)

JSR Operands:

The JSR instruction jumps execution to a different routine. The SBR and RET instructions are optional instructions that exchange data with the JSR instruction.

Relay Ladder

Operand

Routine name

Input parameter

Type

ROUTINE

BOOL

SINT

Return parameter

INT

DINT

REAL structure

BOOL

SINT

INT

DINT

REAL structure

Format

name immediate tag array tag data from this routine that you want to copy to a tag in the subroutine

•

Input parameters are optional.

•

Enter multiple input parameters, if needed.

tag array tag

Description

routine to execute (that is, subroutine) tag in this routine to which you want to copy a result of the subroutine

•

Return parameters are optional.

•

Enter multiple return parameters, if needed.

436




JSR Operands Continued:

JSR(RoutineName,InputCount,

InputPar,ReturnPar);

Structured Text

Operand

Routine name

Type

ROUTINE

Input count SINT

Input parameter

Return parameter

INT

DINT

REAL

BOOL

SINT

INT

DINT

REAL structure

BOOL

SINT

INT

DINT

REAL structure

Function Block

Format

name

Description

routine to execute (that is, subroutine) immediate number of input parameters immediate tag array tag data from this routine that you want to copy to a tag in the subroutine

•

Input parameters are optional.

•

Enter multiple input parameters, if needed.

tag array tag tag in this routine to which you want to copy a result of the subroutine

•

Return parameters are optional.

•

Enter multiple return parameters, if needed.

Input Parameters

❇

Return Parameters

❇

The operands are the same as those for the relay ladder JSR instruction.



437


ATTENTION

For each parameter in a SBR or RET instruction, use the same data type (including any array dimensions) as the corresponding parameter in the JSR instruction. Using different data types may produce unexpected results.

SBR Operands:

The SBR instruction must be the first instruction in a relay ladder or structured text routine.

Relay Ladder

Operand

Input parameter

Type

BOOL

SINT

INT

DINT

REAL structure

Format

tag array tag

Description

tag in this routine into which you want to copy the corresponding input parameter from the JSR instruction

SBR(InputPar);

Structured Text

The operands are the same as those for the relay ladder SBR instruction.

Function Block

Parameters

❇

The operands are the same as those for the relay ladder SBR instruction.

438




RET Operands:

RET(ReturnPar);

Relay Ladder

Operand

Return parameter

Type

BOOL

SINT

INT

DINT

REAL structure

Format

immediate tag array tag

Description

data from this routine that you want to copy to the corresponding return parameter in the

JSR instruction

Structured Text

The operands are the same as those for the relay ladder RET instruction.

Function Block

Parameters

❇

The operands are the same as those for the relay ladder RET instruction.

Description:

The JSR instruction initiates the execution of the specified routine, which is referred to as a subroutine:

•

The subroutine executes one time.

•

After the subroutine executes, logic execution returns to the routine that contains the JSR instruction.

To program a jump to a subroutine, follow these guidelines:

IMPORTANT

Do not use a JSR instruction to call (execute) the main routine.

•

You can put a JSR instruction in the main routine or any other routine.

•

If you use a JSR instruction to call the main routine and then put a RET instruction in the main routine, a major fault occurs (type 4, code 31).



439


JSR

1. If you want to copy data to a tag in the subroutine, enter an input parameter.

2. If you want to copy a result of the subroutine to a tag in this routine, enter a return parameter.

3. Enter as many input and return parameters as you need.

The following diagram illustrates how the instructions operate.

Calling Routine

JSR

Subroutine

SBR

RET

SBR

1. If the JSR instruction has an input parameter, enter an SBR instruction.

2. Place the SBR instruction as the first instruction in the routine.

3. For each input parameter in the JSR instruction, enter the tag into which

RET

42974

RET

1. If the JSR instruction has a return parameter, enter an RET instruction.

2. Place the RET instruction as the last instruction in the routine.

3. For each return parameter in the JSR instruction, enter a return parameter to send to the JSR instruction.

4. In a ladder routine, place additional RET instructions to exit the subroutine based on different input conditions, if required.

There are no restrictions, other than controller memory, on the number of nested routines you can have or the number of parameters you pass or return.

level 1 level 2 level 3 main routine

action_1

JSR

SBR SBR SBR

action_2

JSR

action_3

JSR

RET RET RET

440








JSR instruction has fewer input parameters than SBR instruction

JSR instruction jumps to a fault routine

RET instruction has fewer return parameters than JSR instruction main routine contains a RET instruction

Execution:

Relay Ladder and Structured Text

Fault Type

4

4 or user-supplied

4

4

Fault Code

31

0 or user-supplied

31

31

Condition

prescan

Relay Ladder Action Structured Text Action

The controller executes all subroutines regardless of rung condition. To ensure that all rungs in the subroutine are prescanned, the controller ignores RET instructions. (that is, RET instructions do not exit the subroutine.)

•

Release 6.x and earlier, input and return parameters are passed.

•

Release 7.x and later, input and return parameters are not passed.

If recursive calls exist to the same subroutine, the subroutine is prescanned only the first time. If multiple calls exist (non-recursive) to the same subroutine, the subroutine is prescanned each time.

rung-condition-in is false to the JSR instruction

The rung-condition-out is set to false (relay ladder only).

The subroutine does not execute.

na

Outputs in the subroutine remain in their last state.


EnableIn is set




na na





441


Condition

instruction execution


input parameters yes no logic execution begins in routine identified by JSR

JSR copies input parameters to appropriate SBR tags


RET instruction no yes return parameters yes no

RET copies return parameters to appropriate JSR tags postscan end of subroutine yes no rung-condition-out is set to false rung-condition-out is set to true end

Same action as prescan described above.

Same action as prescan described above.

442



Condition:

prescan instruction first scan instruction first run normal execution postscan


Function Block

Action

No action taken.

No action taken.

No action taken.

1. If the routine contains an SBR instruction, the controller first executes the SBR instruction.

2. The controller latches all data values in IREFs.

3. The controller executes the other function blocks in the order that is determined by their wiring. This includes other JSR instructions.

4. The controller writes outputs in OREFs.

5. If the routine contains an RET instruction, the controller executes the RET instruction last.

The subroutine is called.

If the routine is an SFC routine, the routine in initialized the same as it is during prescan.



443


Routine:

Main routine

Example 1:

The JSR instruction passes value_1 and value_2 to routine_1.

The SBR instruction receives value_1 and value_2 from the JSR instruction and copies those values to value_a and value_b, respectively. Logic execution continues in this routine.

The RET instruction sends float_a to the JSR instruction. The JSR instruction receives float_a and copies the value to float_value_1. Logic execution continues with the next instruction following the JSR instruction.

Relay Ladder

Program

Subroutine

[other rungs of code]

Routine

Main routine

Subroutine

Structured Text

Program

JSR(routine_1,2,value_1,value_2,float_value_1);

SBR(value_a,value_b);

<statements>;

RET(float_a);

444




Example 2:

Relay Ladder

MainRoutine

When abc is on, subroutine_1 executes, calculates the number of cookies, and places a value in cookies_1.

Adds the value in cookies_1 to cookies_2 and stores the result in total_cookies.

Subroutine_1

When def is on, the RET instruction returns value_1 to the JSR cookies_1 parameter and the rest of the subroutine is not scanned.

When def is off (previous rung) and ghi is on, the RET instruction returns value_2 to the JSR cookies_1 parameter and the rest of the subroutine is not scanned.

When both def and ghi are off (previous rungs), the RET instruction returns value_3 to the JSR cookies_1 parameter.



445


Example 3:

Function Block

JSR instruction in Routine_A

42972

1. The values in

Add_Input_1,

Add_Input_2, and

Add_Input_3 are copied to Input_A, Input_B, and

Input_C, respectively.

Function blocks of the Add_Three_Inputs routine

3. The value of Sum_A_B_C is copied to Add_Three_Result.

2. The ADD instructions add Input_A, Input_B, and Input_C and place the result in Sum_A_B_C.

42973

446




Jump to External Routine

(JXR)

Operands:

The JXR instruction executes an external routine. This instruction is only supported by the SoftLogix5800 controllers.

Relay Ladder

.

Operand

External routine name

External routine control

Parameter

Type

ROUTINE

EXT_ROUTINE_

CONTROL

BOOL

Format

name tag immediate

SINT tag array tag

INT

DINT

REAL

Return parameter structure

BOOL

SINT

INT

DINT

REAL tag

Description

external routine to execute control structure (see the next page) data from this routine that you want to copy to a variable in the external routine

•

Parameters are optional.

•

Enter multiple parameters, if needed.

•

You can have as many as 10 parameters.

tag in this routine to which you want to copy a result of the external routine

•

The return parameter is optional.

•

You can have only one return parameter



447


EXT_ROUTINE_CONTROL Structure

Mnemonic

ErrorCode

NumParams

ParameterDefs

ReturnParamDef

EN

ReturnsValue

DN

ER

FirstScan

EnableOut

EnableIn

User1

User0

ScanType1

ScanType0

Data Type

SINT

SINT

EXT_ROUTINE_

PARAMETERS[10]

EXT_ROUTIN_

PARAMETERS

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

Description

If an error occurs, this value identifies the error.

Valid values are from 0-255.

This value indicates the number of parameters associated with this instruction.

This array contains definitions of the parameters to pass to the external routine. The instruction can pass as many as 10 parameters.

Implementation

There are no predefined error codes. The developer of the external routine must provide the error codes.

Display only - this information is derived from the instruction entry.


This value contains definitions of the return parameter from the external routine. There is only one return parameter.

When set, the enable bit indicates that the JXR instruction is enabled.

If set, this bit indicates that a return parameter was entered for the instruction. If cleared, this bit indicates that no return parameter was entered for the instruction.

The done bit is set when the external routine has executed once to completion.

The error bit is set if an error occurs. The instruction stops executing until the program clears the error bit.


The external routine sets this bit.




This bit identifies whether this is the first scan after switching the controller to Run mode. Use

FirstScan to initialize the external routine, if needed.

The controller sets this bit to reflect scan status.

Enable output.

Enable input.

These bits are available for the user. The controller does not initialize these bits.


The controller sets this bit to reflect rung-condition-in. The instruction executes regardless of rung condition. The developer of the external routine should monitor this status and act accordingly.

Either the external routine or the user program can set these bits.

These bits identify the current scan type:

Bit Values: Scan Type:

00

01

Normal

Pre Scan

10 Post Scan (not applicable to relay ladder programs)

The controller sets these bits to reflect scan status.

448




Description:

Use the Jump to External Routine (JXR) instruction to call the external routine from a ladder routine in your project. The JXR instruction supports multiple parameters so you can pass values between the ladder routine and the external routine.

The JXR instruction is similar to the Jump to Subroutine (JSR) instruction.

The JXR instruction initiates the execution of the specified external routine:

•

The external routine executes one time.

•

After the external routine executes, logic execution returns to the routine that contains the JXR instruction.


Arithmetic status flags are not affected.



• an exception occurs in the external routine DLL

• the DLL could not be loaded

• the entry point was not found in the DLL

Fault Type

4

Fault code:

88

Execution:

The JXR can be synchronous or asynchronous depending on the implementation of the DLL. The code in the DLL also determines how to respond to scan status, rung-condition-in status, and rung-condition-out status.

For more information on using the JXR instruction and creating external routines, see the SoftLogix5800 System User Manual, publication

1789-UM002.



449


Temporary End (TND)

The TND instruction acts as a boundary.

Operands:


none

TND();

Structured Text

none

You must enter the parentheses () after the instruction mnemonic, even though there are no operands.

Description:

When enabled, the TND instruction lets the controller execute logic only up to this instruction.

When enabled, the TND instruction acts as the end of the routine. When the controller scans a TND instruction, the controller moves to the end of the current routine. If the TND instruction is in a subroutine, control returns to the calling routine. If the TND instruction is in a main routine, control returns to the next program within the current task.


not affected


none

Execution:

Condition


EnableIn is set






na


No action taken.

na na instruction execution postscan

The current routine terminates.




The current routine terminates.

No action taken.

450




Example:

You can use the TND instruction when debugging or troubleshooting to execute logic up to a certain point. Progressively move the TND instruction through the logic as you debug each new section.

When the TND instruction is enabled, the controller stops scanning the current routine.

Relay Ladder

Structured Text

TND();



451


Master Control Reset (MCR)

The MCR instruction, used in pairs, creates a program zone that can disable all rungs within the MCR instructions.

Operands:

Relay Ladder

none

Description:

When the MCR zone is enabled, the rungs in the MCR zone are scanned for normal true or false conditions. When disabled, the controller still scans rungs within an MCR zone, but scan time is reduced because non-retentive outputs in the zone are disabled. The rung-condition-in is false for all the instructions inside of the disabled MCR zone.

When you program an MCR zone, note that:

•

You must end the zone with an unconditional MCR instruction.

•

You cannot nest one MCR zone within another.

•

Do not jump into an MCR zone. If the zone is false, jumping into the zone activates the zone from the point to which you jumped to the end of the zone.

•

If an MCR zone continues to the end of the routine, you do not have to program an MCR instruction to end the zone.

The MCR instruction is not a substitute for a hard-wired master control relay that provides emergency-stop capability. You should still install a hard-wired master control relay to provide emergency I/O power shutdown.

ATTENTION

Do not overlap or nest MCR zones. Each MCR zone must be separate and complete. If they overlap or nest, unpredictable machine operation could occur with possible damage to equipment or injury to personnel.

Place critical operations outside the MCR zone. If you start instructions such as timers in a MCR zone, instruction execution stops when the zone is disabled and the timer is cleared.


not affected


none

452




Condition


Execution:




The instructions in the zone are scanned, but the rung-condition-in is false and non-retentive outputs in the zone are disabled.


The instructions in the zone are scanned normally.


Example:

When the first MCR instruction is enabled (input_1, input_2, and input_3 are set), the controller executes the rungs in the MCR zone (between the two

MCR instructions) and sets or clears outputs, depending on input conditions.

When the first MCR instruction is disabled (input_1, input_2, and input_3 are not all set), the controller executes the rungs in the MCR zone (between the two MCR instructions) and the rung-condition-in goes false for all the rungs in the MCR zone, regardless of input conditions.



453


User Interrupt Disable (UID)

User Interrupt Enable (UIE)

The UID instruction and the UIE instruction work together to prevent a small number of critical rungs from being interrupted by other tasks.

Operands:

UID();

UIE();

Relay Ladder

none

Structured Text

none

You must enter the parentheses () after the instruction mnemonic, even though there are no operands.

Description:

When the rung-condition-in is true, the:

•

UID instruction prevents higher-priority tasks from interrupting the current task but does not disable execution of a fault routine or the

Controller Fault Handler.

•

UIE instruction enables other tasks to interrupt the current task.

To prevent a series of rungs from being interrupted:

1.

Limit the number of rungs that you do not want interrupted to as few as possible. Disabling interrupts for a prolonged period of time can produce communication loss.

2.

Above the first rung that you do not want interrupted, enter a rung and a

UID instruction.

3.

After the last rung in the series that you do not want interrupted, enter a rung and a UIE instruction.

4.

If required, you can nest pairs of UID/UIE instructions.


not affected


none

454




Execution:

Condition


EnableIn is set instruction execution postscan






No action taken.

na na


na EnableIn is always set.


The UID instruction prevents interruption by higher-priority tasks.

The UIE instruction enables interruption by higher-priority tasks.


No action taken.

Example:

When an error occurs (error_bit is on), the FSC instruction checks the error code against a list of critical errors. If the FSC instruction finds that the error is critical (error_check.FD is on), an alarm is annunciated. The UID and UIE instructions prevent any other tasks from interrupting the error checking and alarming.

Relay Ladder

error_bit error_check.FD

UID

File Search/Compare

FSC

EN

Control

Length

Position

Mode error_check

10

8

ALL

DN

ER

Expression error_code=error_list[error_check.POS] alarm

UIE

Structured Text

UID();

<statements>

UIE();



455


Always False Instruction

(AFI)

The AFI instruction sets its rung-condition-out to false.

Operands:

Relay Ladder

none

Description:

The AFI instruction sets its rung-condition-out to false.


not affected


none

Execution:

Condition







Example:

Use the AFI instruction to temporarily disable a rung while you are debugging a program.

When enabled, the AFI disables all the instructions on this rung.

456




No Operation (NOP)

The NOP instruction functions as a placeholder

Operands:

Relay Ladder

none

Description:

You can place the NOP instruction anywhere on a rung. When enabled the

NOP instruction performs no operation. When disabled, the NOP instruction performs no operation.


not affected


none

Execution:

Condition







Example

This instruction is useful for locating unconditional branches when you place the NOP instruction on the branch.

The NOP instruction bypasses the XIC instruction to enable the output.



457


End of Transition (EOT)

Operands:

The EOT instruction returns a boolean state to an SFC transition.

Relay Ladder

Operand

data bit

Type

BOOL

Format

tag

Description

state of the transition

(0=executing, 1=completed)

EOT(data_bit);

Structured Text

The operands are the same as those for the relay ladder EOT instruction.

Description:

Because the EOT instruction returns a boolean state, multiple SFC routines can share the same routine that contains the EOT instruction. If the calling routine is not a transition, the EOT instruction acts as a TND instruction (see page 450 ).

The Logix implementation of the EOT instruction differs from that in a

PLC-5 controller. In a PLC-5 controller, the EOT instruction has no parameters. Instead, the PLC-5 EOT instruction returns rung condition as its state. In a Logix controller, the return parameter returns the transition state since rung condition is not available in all Logix programming languages.


not affected


none

Execution:

Condition








na

Structured Text Action:

No action taken.

na na



The instruction returns the data bit value to the calling routine.


No action taken.

458




Example:

When both limit_switch1 and interlock_1 are set, set state. After timer_1 completes, EOT returns the value of state to the calling routine.

Relay Ladder

Structured Text

state := limit_switch1 AND interlock_1;

IF timer_1.DN THEN

EOT(state);

END_IF;



459


SFC Pause (SFP)

The SFP instruction pauses an SFC routine.

Operands:

Relay Ladder

Operand

SFCRoutine

Name

Type:

ROUTINE

TargetState DINT

Format:

name

Description:

SFC routine to pause immediate tag select one: executing (or enter 0) paused (or enter 1)

Structured Text

SFP(SFCRoutineName,

TargetState);

The operands are the same as those for the relay ladder SFP instruction.

Description:

The SFP instruction lets you pause an executing SFC routine. If an SFC routine is in the paused state, use the SFP instruction again to change the state and resume execution of the routine.

Also, use the SFP instruction to resume SFC execution after using an SFR instruction (see page 462 ) to reset an SFC routine.


not affected


A Major Fault Will Occur If:

the routine type is not an SFC routine

Fault Type

4

Fault Code

85

460




Execution:

Condition:








na


No action taken.

na na



The instruction pauses or resumes execution of the specified SFC routine.


No action taken.

Example:

If sfc_en_p is set, pause the SFC routine named normal. Restart the SFC when

sfc_en_e is set.

Relay Ladder

Pause the SFC routine.

Resume executing the SFC routine.

Structured Text

Pause the SFC routine:

IF (sfp_en_p) THEN

SFP(normal,paused); sfp_en_p := 0;

END_IF;



461


Resume executing the SFC routine:

IF (sfp_en_e) THEN

SFP(normal,executing); sfp_en_e := 0;

END_IF;

SFC Reset (SFR)

The SFR instruction resets the execution of a SFC routine at a specified step.

Operands:


Operand

SFCRoutine

Name

Type

ROUTINE

Format

name

Step Name SFC_STEP tag

Description

SFC routine to reset target step where to resume execution

Structured Text

SFR(SFCRoutineName,StepName);

The operands are the same as those for the relay ladder SFR instruction.

Description:

When the SFR instruction is enabled:

•

In the specified SFC routine, all stored actions stop executing (reset).

•

The SFC begins executing at the specified step.

If the target step is 0, the chart will be reset to its initial step

The Logix implementation of the SFR instruction differs from that in a PLC-5 controller. In the PLC-5 controller, the SFR executed when the rung condition was true. After reset, the SFC would remain paused until the rung containing the SFR became false. This allowed the execution following a reset to be delayed. This pause/un-pause feature of the PLC-5 SFR instruction was decoupled from the rung condition and moved into the SFP instruction.


not affected



the routine type is not an SFC routine specified target step does not exist in the SFC routine

Fault Type

4

4

Fault Code

85

89

462




Execution:

Condition


EnableIn is set








No action taken.

na na

The instruction resets the specified SFC routine.




The instruction resets the specified SFC routine.

No action taken.

Example:

If a specific condition occurs (shutdown is set), restart the SFC at step initialize.

Relay Ladder

Structured Text

IF shutdown THEN

SFR(mySFC,initialize);

END_IF;



463


Trigger Event Task (EVENT)

The EVENT instruction triggers one execution of an event task.

Operands:

Relay Ladder

Operand

Task

Type

TASK

Format

name

Description

event task to execute

The instruction lets you choose other types of tasks, but it does not execute them.

EVENT(task_name);

Structured Text

The operands are the same as those for the relay ladder EVENT instruction.

Description:

Use the EVENT instruction to programmatically execute an event task:

•

Each time the instruction executes, it triggers the specified event task.

•

Make sure that you give the event task enough time to complete its execution before you trigger it again. If not, an overlap occurs.

•

If you execute an EVENT instruction while the event task is already executing, the controller increments the overlap counter but it does not trigger the event task.

Programmatically Determine if an EVENT Instruction Triggered a Task

To determine if an EVENT instruction triggered an event task, use a

Get System Value (GSV) instruction to monitor the Status attribute of the task.

Status Attribute of the TASK Object

Attribute

Status

Data Type

DINT

Instruction

GSV

SSV

Description

Provides status information about the task. Once the controller sets a bit, you must manually clear the bit to determine if another fault of that type occurred.

To determine if:

An EVENT instruction triggered the task (event task only).

A timeout triggered the task (event task only).

An overlap occurred for this task.

Examine this bit:

0

1

2

464




The controller does not clear the bits of the Status attribute once they are set.

•

To use a bit for new status information, you must manually clear the bit.

•

Use a Set System Value (SSV) instruction to set the attribute to a different value.


not affected


none

Execution:

Condition:








No action taken.

na na




The instruction triggers one execution of the specified event task


No action taken.



465


Example 1:

A controller uses multiple programs but a common shut down procedure.

Each program uses a program-scoped tag named Shut_Down_Line that turns on if the program detects a condition that requires a shut down. The logic in each program executes as follows:

If Shut_Down_Line = on (conditions require a shut down) then

Execute the Shut_Down task one time

Relay Ladder

Program A

Program B

Structured Text

Program A

IF Shut_Down_Line AND NOT Shut_Down_Line_One_Shot THEN

EVENT (Shut_Down);

END_IF;

Shut_Down_Line_One_Shot := Shut_Down_Line;

Program B

IF Shut_Down_Line AND NOT Shut_Down_Line_One_Shot THEN

EVENT (Shut_Down);

END_IF;

Shut_Down_Line_One_Shot := Shut_Down_Line;

466




Example 2:

The following example uses an EVENT instruction to initialize an event task.

(Another type of event normally triggers the event task.)

Continuous task

If Initialize_Task_1 = 1 then

The ONS instruction limits the execution of the EVENT instruction to one scan.

The EVENT instruction triggers an execution of Task_1 (event task).

Task_1 (event task)

The GSV instruction sets Task_Status (DINT tag) = Status attribute for the event task. In the Instance Name attribute, THIS means the TASK object for the task that the instruction is in (that is, Task_1).

If Task_Status.0 = 1 then an EVENT instruction triggered the event task (that is, when the continuous task executes its EVENT instruction to initialize the event task).

The RES instruction resets a counter that the event task uses.

The controller does not clear the bits of the Status attribute once they are set. To use a bit for new status information, you must manually clear the bit.

If Task_Status.0 = 1 then clear that bit.

The OTU instruction sets Task_Status.0 = 0.

The SSV instruction sets the Status attribute of THIS task (Task_1) = Task_Status. This includes the cleared bit.



467


Notes:

468



Chapter

12

For/Break Instructions

(FOR, FOR...DO, BRK, EXIT, RET)

Introduction

Use the FOR instruction to repeatedly call a subroutine. Use the BRK instruction to interrupt the execution of a subroutine.

If You Want To

Repeatedly execute a routine.

Terminate the repeated execution of a routine.

Return to the FOR instruction.

(1)



FOR

FOR...DO

(1)

BRK

EXIT

(1)

RET


relay ladder structured text relay ladder structured text relay ladder

See Page

470

473

474



469

Chapter 12 For/Break Instructions (FOR, FOR...DO, BRK, EXIT, RET)

For (FOR)

The FOR instruction executes a routine repeatedly.

Operands:

Relay Ladder

Operand

Routine name

Index

Type

ROUTINE

DINT

Initial value SINT

INT

Terminal value

DINT

SINT

Step size

INT

DINT

SINT

INT

DINT

Format

routine name tag

Description

routine to execute immediate tag counts how many times the routine has been executed value at which to start the index immediate tag value at which to stop executing the routine immediate tag amount to add to the index each time the

FOR instruction executes the routine

Structured Text

FOR count:= initial_value TO

final_value BY increment DO

<statement>;

END_FOR;

Use the FOR...DO construct. See Appendix C, Structured Text Programming for information on structured text constructs.

Description:

IMPORTANT

Do not use a FOR instruction to call (execute) the main routine.

•

You can put a FOR instruction in the main routine or any other routine.

•

If you use a FOR instruction to call the main routine and then put a RET instruction in the main routine, a major fault occurs (type 4, code 31).

When enabled, the FOR instruction repeatedly executes the Routine until the

Index value exceeds the Terminal value. This instruction does not pass parameters to the routine.

470



For/Break Instructions (FOR, FOR...DO, BRK, EXIT, RET) Chapter 12

Condition

prescan

Each time the FOR instruction executes the routine, it adds the Step size to the Index.

Be careful not to loop too many times in a single scan. An excessive number of repetitions can cause the controller’s watchdog to timeout, which causes a major fault.


not affected



main routine contains a RET instruction

Fault Type

4

Fault Code

31

Execution:




The controller executes the subroutine once.

If recursive FOR instruction0s exist to the same subroutine, the subroutine is prescanned only the first time. If multiple FOR instructions exist (non-recursive) to the same subroutine, the subroutine is prescanned each time.




471




index = initial_value postscan no step size < 0 yes goto end no index

≤ yes yes index

≥

terminal value no execute routine goto end end rung-condition-out is set to true end


Example:

When enabled, the FOR instruction repeatedly executes routine_2 and increments value_2 by 1 each time. When value_2 is

>

10 or a BRK instruction is enabled, the FOR instruction no longer executes routine_2.

472




Break (BRK)

The BRK instruction interrupts the execution of a routine that was called by a

FOR instruction.

Operands:

EXIT;

Relay Ladder

none

Structured Text

Use the EXIT statement in a loop construct. See Appendix B for information on structured text constructs.

Description:

When enabled, the BRK instruction exits the routine and returns the controller to the instruction that follows the FOR.

If there are nested FOR instructions, a BRK instruction returns control to the innermost FOR instruction.


not affected


none

Execution:

Condition






Execution returns to the instruction that follows the calling FOR instruction.


Example:

When enabled, the BRK instruction stops executing the current routine and returns to the instruction that follows the calling FOR instruction.



473


Return (RET)

The RET instruction returns to the calling FOR instruction.

Operands:

Relay Ladder

none

Description:

IMPORTANT

Do not place a RET instruction in the main routine. If you place a RET instruction in the main routine, a major fault occurs (type

4, code 31).

postscan

When enabled, the RET instruction returns to the FOR instruction. The FOR instruction increments the Index value by the Step size and executes the subroutine again. If the Index value exceeds the Terminal value, the FOR instruction completes and execution moves on to the instruction that follows the FOR instruction.

The FOR instruction does not use parameters. The FOR instruction ignores any parameters you enter in a RET instruction.

You could also use a TND instruction to end execution of a subroutine.


not affected



main routine contains a RET instruction

Fault Type

4

Fault Code

31

Execution:

Condition:





Returns the specified parameters to the calling routine.



474




Example:

The FOR instruction repeatedly executes routine_2 and increments value_2 by 1 each time. When value_2 is

>

10 or a BRK instruction is enabled, the FOR instruction no longer executes routine_2.

The RET instruction returns to the calling FOR instruction. The FOR instruction either executes the subroutine again and increments the Index value by the Step size or, if the Index value exceeds the Terminal value, the

FOR instruction is complete and execution moves on to the instruction that follows the FOR instruction.

calling routine subroutine



475


Notes:

476



Chapter

13

Special Instructions

(FBC, DDT, DTR, PID)

Introduction

The special instructions perform application-specific operations.

If You Want To

Compare data against a known, good reference and record any mismatches.

Compare data against a known, good reference, record any mismatches, and update the reference to match the source.

Pass the source data through a mask and compare the result to reference data. Then write the source into the reference for the next comparison.

Control a PID loop.


FBC

DDT

DTR

PID


relay ladder relay ladder relay ladder relay ladder structured text

See Page

478

486

494

497



477

Chapter 13 Special Instructions (FBC, DDT, DTR, PID)

File Bit Comparison (FBC)

The FBC instruction compares bits in a Source array with bits in a Reference array.

Operands:

Relay Ladder

Operand

Source

Type

DINT

Reference DINT

Result

Cmp control CONTROL

Length DINT

Position DINT

Result control

Length

Position

DINT

CONTROL

DINT

DINT

Format

array tag array tag

Description:

array to compare to the reference

do not use CONTROL.POS in the subscript array to compare to the source

do not use CONTROL.POS in the subscript array to store the result array tag

do not use CONTROL.POS in the subscripts structure control structure for the compare immediate number of bits to compare immediate current position in the source structure initial value is typically 0 control structure for the results immediate number of storage locations in the result immediate current position in the result initial value is typically 0

ATTENTION

Use different tags for the compare control structure and the result control structure. Using the same tag for both could result in unpredictable operation, possibly causing equipment damage and/or injury to personnel.

478



Mnemonic:

.EN

.DN

.FD

.IN

.ER

.LEN

.POS

Mnemonic

.DN

.LEN

.POS

Special Instructions (FBC, DDT, DTR, PID) Chapter 13

Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

COMPARE Structure

Description:

The enable bit indicates that the FBC instruction is enabled.

The done bit is set when the FBC instruction compares the last bit in the Source and

Reference arrays.

The found bit is set each time the FBC instruction records a mismatch (one-at-a-time operation) or after recording all mismatches (all-per-scan operation).

The inhibit bit indicates the FBC search mode.

0 = all mode

1 = one mismatch at a time mode

The error bit is set if the compare .POS < 0, the compare .LEN < 0, the result .POS < 0 or the result .LEN < 0. The instruction stops executing until the program clears the .ER bit.

The length value identifies the number of bits to compare.

The position value identifies the current bit.

RESULT Structure

Data Type

BOOL

DINT

DINT

Description

The done bit is set when the Result array is full.

The length value identifies the number of storage locations in the Result array.

The position value identifies the current position in the Result array.

Description:

When enabled, the FBC instruction compares the bits in the Source array with the bits in the Reference array and records the bit number of each mismatch in the Result array.

IMPORTANT


The FBC instruction operates on contiguous memory. In some cases, the instruction searches or writes past the array into other members of the tag. This happens if a length is too big and the tag is a user-defined data type.

The difference between the DDT and FBC instructions is that each time the

DDT instruction finds a mismatch, the instruction changes the reference bit to match the source bit. The FBC instruction does not change the reference bit.



479


Selecting the Search Mode

If You Want To Detect

One mismatch at a time

All mismatches


Set the .IN bit in the compare CONTROL structure.

Each time the rung-condition-in goes from false to true, the FBC instruction searches for the next mismatch between the Source and Reference arrays. Upon finding a mismatch, the instruction sets the .FD bit, records the position of the mismatch, and stops executing.

Clear the .IN bit in the compare CONTROL structure.

Each time the rung-condition-in goes from false to true, the FSC instruction searches for all mismatches between the Source and Reference arrays.


not affected



Result.POS > size of Result array

Fault Type

4

Fault Code

20

480



Condition

prescan compare.EN bit is cleared

Execution:


examine compare.DN bit compare.DN = 0 compare.DN = 1 compare.DN bit is cleared compare.POS value is cleared result.DN bit is cleared rung-condition-out is set to

false

end




481



rung-condition-in is false compare.EN bit is cleared examine compare.DN bit compare.DN = 0 compare.DN = 1 compare DN bit is cleared compare.POS value is cleared result.DN bit is cleared rung-condition-out is set to

false

end

482




Condition



examine compare.EN bit compare.EN = 1 compare.EN = 0 compare EN bit is set goto exit examine compare.DN bit compare.DN = 1 compare.DN = 0 compare.ER bit is cleared goto exit compare.LEN

≤ yes no

exit

compare.POS < 0 yes no compare.ER bit is set rung-condition-out is set to true end compare page 484 goto exit



483



compare compare.POS

≥ compare.LEN

yes no compare.POS = compare.LEN

source[compare.POS] = reference[compare.POS] no yes compare.POS = compare.POS + 1 compare.FD bit is set major fault goto exit page 483 result.DN = 1 examine result.DN bit result.DN = 0 result.DN bit is cleared result.POS value is cleared result.POS < 0 no yes result.LEN

≤ no yes compare.ER bit is set yes result.POS > size of result array no result[result.POS] = compare.POS

result.POS = result.POS + 1 goto exit page 483 postscan

484

no result.POS > result.LEN

yes result.DN bit is set





Example:

When enabled, the FBC instruction compares the source array_dint1 to the reference array_dint2 and stores the locations of any mismatches in the result

array_dint3.

source

array_dint1

0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 reference

array_dint2

0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 0 result

array_dint3

5 3



485


Diagnostic Detect (DDT)

The DDT instruction compares bits in a Source array with bits in a Reference array to determine changes of state.

Operands:

Relay Ladder

Operand

Source

Reference

Result

Cmp control CONTROL

Length DINT

Position DINT

Result control

Length

Position

Type

DINT

DINT

DINT

CONTROL

DINT

DINT

Format

array tag array tag

Description

array to compare to the reference

do not use CONTROL.POS in the subscript array to compare to the source

do not use CONTROL.POS in the subscript array to store the results array tag

do not use CONTROL.POS in the subscript structure control structure for the compare immediate number of bits to compare immediate current position in the source structure initial value typically 0 control structure for the results immediate number of storage locations in the result immediate current position in the result initial value typically 0

ATTENTION

Use different tags for the compare control structure and the result control structure. Using the same tag for both could result in unpredictable operation, possibly causing equipment damage and/or injury to personnel.

486



Mnemonic

.EN

.DN

.FD

.IN

.ER

.LEN

.POS

Mnemonic

.DN

.LEN

.POS


Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

COMPARE Structure

Description

The enable bit indicates that the DDT instruction is enabled.

The done bit is set when the DDT instruction compares the last bit in the Source and

Reference arrays.

The found bit is set each time the DDT instruction records a mismatch (one-at-a-time operation) or after recording all mismatches (all-per-scan operation).

The inhibit bit indicates the DDT search mode.

0 = all mode

1 = one mismatch at a time mode

The error bit is set if the compare .POS < 0, the compare .LEN < 0, the result .POS < 0 or the result .LEN < 0. The instruction stops executing until the program clears the .ER bit.

The length value identifies the number of bits to compare.

The position value identifies the current bit.

RESULT Structure

Data Type

BOOL

DINT

DINT

Description

The done bit is set when the Result array is full.

The length value identifies the number of storage locations in the Result array.

The position value identifies the current position in the Result array.

Description:

When enabled, the DDT instruction compares the bits in the Source array with the bits in the Reference array, records the bit number of each mismatch in the Result array, and changes the value of the Reference bit to match the value of the corresponding Source bit.

IMPORTANT


The DDT instruction operates on contiguous memory. In some cases, the instruction searches or writes past the array into other members of the tag. This happens if a length is too big and the tag is a user-defined data type.

The difference between the DDT and FBC instructions is that each time the

DDT instruction finds a mismatch, the DDT instruction changes the reference bit to match the source bit. The FBC instruction does not change the reference bit.



487


Selecting the search mode

If You Want To Detect

One mismatch at a time

All mismatches


Set the .IN bit in the compare CONTROL structure.

Each time the rung-condition-in goes from false to true, the DDT instruction searches for the next mismatch between the Source and Reference arrays. Upon finding a mismatch, the instruction sets the .FD bit, records the position of the mismatch, and stops executing.

Clear the .IN bit in the compare CONTROL structure.

Each time the rung-condition-in goes from false to true, the DDT instruction searches for all mismatches between the Source and Reference arrays.


not affected



Result.POS > size of Result array

Fault Type:

4

Fault Code

20

488



Condition:

prescan compare.EN bit is cleared

Execution:


examine compare.DN bit compare.DN = 0 compare.DN = 1 compare.DN bit is cleared compare.POS value is cleared result.DN bit is cleared rung-condition-out is set to

false

end




489



rung-condition-in is false compare.EN bit is cleared examine compare.DN bit compare.DN = 0 compare.DN = 1 compare DN bit is cleared compare.POS value is cleared result.DN bit is cleared rung-condition-out is set to

false

end

490




Condition:



examine compare.EN bit compare.EN = 1 compare.EN = 0 compare EN bit is set examine compare.DN bit compare.DN bit = 1 compare.DN bit = 0 compare.ER bit is cleared compare.FD bit is cleared goto exit goto exit compare.LEN

≤ yes no

exit

compare.POS < 0 yes no compare.ER bit is set rung-condition-out is set to true end compare page 492 goto exit



491



compare compare.POS

≥ compare.LEN

yes no compare.POS = compare.LEN

source[compare.POS] = reference[compare.POS] no yes compare.POS = compare.POS + 1 compare.FD bit is set reference[compare.POS]

= source[compare.POS] major fault goto exit page 491 result.DN = 1 examine result.DN bit result.DN = 0 result.DN bit is cleared result.POS value is cleared result.POS < 0 no yes result.LEN

≤ no yes compare.ER bit is set yes result.POS > size of result array no result[result.POS] = compare.POS

result.POS = result.POS + 1 goto exit page 483 no result.POS

≥ result.LEN

yes result.DN bit is set


postscan

492




Example:

When enabled, the DDT instruction compares the source array_dint1 to the reference array_dint2 and stores the locations of any mismatches in the result

array_dint3. The controller also changes the mismatched bits in the reference

array_dint2 to match the source array_dint1.

source 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

array_dint1

reference (before compare) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 0

array_dint2

result 5 3

array_dint3

reference (after compare) 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

array_dint2



493


Data Transitional (DTR)

The DTR instruction passes the Source value through a Mask and compares the result with the Reference value.

Operands:

Relay Ladder

Operand: Type

Source DINT

Mask DINT

Format

immediate tag immediate tag tag

Description

array to compare to the reference which bits to block or pass array to compare to the source Reference DINT

Description:

The DTR instruction passes the Source value through a Mask and compares the result with the Reference value. The DTR instruction also writes the masked Source value into the Reference value for the next comparison. The

Source remains unchanged.

A “1” in the mask means the data bit is passed. A “0” in the mask means the data bit is blocked.

When the masked Source differs from the Reference, the rung-condition-out goes true for one scan. When the masked Source is the same as the Reference, the rung-condition-out is false.

ATTENTION

Online programming with this instruction can be dangerous. If the Reference value is different than the Source value, the rung-condition-out goes true. Use caution if you insert this instruction when the processor is in Run or Remote Run mode.

494




Condition

prescan

Enter an immediate mask value



Prefix

16#

8#

2#

Description:



not affected


none

Execution:



The Reference = Source AND Mask.


The Reference = Source AND Mask.


rung-condition-in is true postscan masked source = reference no yes rung-condition-out is set to false reference is set equal to masked source rung-condition-out is set to true end




495


Example:

When enabled, the DTR instruction masks value_1. If there is a difference in the two values, the rung-condition-out is set to true.

example 1

7

1 source

example 2

8 3 9 1 8 7

0 0 0 0 1 1 1 1 1 1 1 1 1 1 1 1 mask = 0FFF

0 0 0 0 1 1 1 1 1 1 1 1 1 1 1 1 reference current scan previous scan

0

0

1

1 8

8 3

3

The rung remains false as long as the input value does not change.

0

0

1

1

8

8

7

3

The rung remains true for one scan when a change is detected.

current scan previous scan

13385

A 0 in the mask leaves the bit unchanged.

496




Proportional Integral

Derivative (PID)

Operands:

The PID instruction controls a process variable such as flow, pressure, temperature, or level.

Relay Ladder

Operand

PID

Process variable

Tieback

DINT

REAL

SINT Control variable

INT

DINT

PID master loop

REAL

PID

Type

PID

SINT

INT

DINT

REAL

SINT

INT

Inhold bit BOOL

Inhold value SINT

INT

DINT

REAL

Format

structure tag immediate tag tag structure tag tag

Description

PID structure value you want to control

(optional) output of a hardware hand/auto station which is bypassing the output of the controller

Enter 0 if you don’t want to use this parameter.

value which goes to the final control device (valve, damper, etc.)

If you are using the deadband, the Control variable must be REAL or it will be forced to 0 when the error is within the deadband.

(optional) PID tag for the master PID

If you are performing cascade control and this PID is a slave loop, enter the name of the master PID. Enter 0 if you don’t want to use this parameter.

(optional) current status of the inhold bit from a 1756 analog output channel to support bumpless restart


(optional) data readback value from a 1756 analog output channel to support bumpless restart




497


Operand

Setpoint

Process variable

Output %

Type

PID(PID,ProcessVariable,

Tieback,ControlVariable,

PIDMasterLoop,InholdBit,

InHoldValue);

Mnemonic:

.CTL

Format

Data Type

DINT

Description

displays current value of the setpoint displays current value of the scaled Process Variable displays current output percentage value

Structured Text

The operands are the same as those for the relay ladder PID instruction.

However, you specify the Setpoint, Process Variable, and Output % by accessing the .SP, .PV.and .OUT members of the PID structure, rather than by including values in the operand list.

PID Structure

28

27

26

25

24

23

22

21

Description

The .CTL member provides access to the status members (bits) in one, 32-bit word. The PID instruction sets bits 07 -15.

This Bit

31

30

29

Is This Member

.EN

.CT

.CL

.PVT

.DOE

.SWM

.CA

.MO

.PE

.NDF

.NOBC

11

10

09

08

07

20

This Bit:

15

.NOZC

Is This Member, Which the PID Instruction Sets

.INI

14 .SPOR

13 .OLL

12 .OLH

.EWD

.DVNA

.DVPA

.PVLA

.PVHA

498




Data Type

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

REAL

.KI

.KD

Mnemonic:

.SP

.KP

.UPD

.PV

.ERR

.OUT

.PVH

.PVL

.DVP

.DVN

.PVDB

.DVDB

.MAXI

.MINI

.BIAS

.MAXS

.MINS

.DB

.SO

.MAXO

.MINO

.TIE

.MAXCV

.MINCV

.MINTIE

.MAXTIE

Description

setpoint independent dependent independent dependent independent proportional gain (unitless) controller gain (unitless) integral gain (1/sec) reset time (minutes per repeat) derivative gain (seconds) dependent rate time (minutes) feedforward or bias % maximum engineering unit scaling value minimum engineering unit scaling value deadband engineering units set output % maximum output limit (% of output) minimum output limit (% of output) loop update time (seconds) scaled PV value scaled error value output % process variable high alarm limit process variable low alarm limit positive deviation alarm limit negative deviation alarm limit process variable alarm deadband deviation alarm deadband maximum PV value (unscaled input) minimum PV value (unscaled input) tieback value for manual control maximum CV value (corresponding to 100%) minimum CV value (corresponding to 0%) minimum tieback value (corresponding to 100%) maximum tieback value (corresponding to 0%)



499


500

.EN

.CT

.CL

.PVT

.DOE

.SWM

.CA

.MO

.PE

.NDF

.NOBC

.NOZC

.INI

.SPOR

.OLL

.OLH

Mnemonic:

.DATA

Data Type

REAL[17]

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

Description

The .DATA member stores:

Element: Description

.DATA[0]

.DATA[1]

.DATA[2]

.DATA[3] integral accumulation derivative smoothing temporary value previous .PV value previous .ERR value

.DATA[4]

.DATA[5]

.DATA[6]

.DATA[7]

.DATA[8]

.DATA[9]

.DATA[10]

.DATA[11] previous valid .SP value percent scaling constant

.PV scaling constant derivative scaling constant previous .KP value previous .KI value previous .KD value dependent gain .KP

.DATA[12]

.DATA[13]

.DATA[14]

.DATA[15] dependent gain .KI

dependent gain .KD

previous .CV value

.CV descaling constant tieback descaling constant .DATA[16] enabled cascade type (0=slave; 1=master) cascade loop (0=no; 1=yes) process variable tracking (0=no; 1=yes) derivative of (0=PV; 1=error) software manual mode (0=no-auto; 1=yes- sw manual) control action (0 means E=SP-PV; 1 means E=PV-SP) station mode (0=automatic; 1=manual)

PID equation (0=independent; 1=dependent) no derivative smoothing

(0=derivative smoothing filter enabled; 1=derivative smoothing filter disabled) no bias back calculation

(0=bias back calculation enabled; 1=bias back calculation disabled) no zero crossing deadband

(0=deadband is zero crossing; 1=deadband is not zero crossing)

PID initialized (0=no; 1=yes) setpoint out of range (0=no; 1=yes)

CV is below minimum output limit (0=no; 1=yes)

CV is above maximum output limit (0=no; 1=yes)




Mnemonic:

.EWD

.DVNA

.DVPA

.PVLA

.PVHA

Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

Description

error is within deadband (0=no; 1=yes) deviation is alarmed low (0=no; 1=yes) deviation is alarmed high (0=no; 1=yes)

PV is alarmed low (0=no; 1=yes)

PV is alarmed high (0=no; 1=yes)

Description:

The PID instruction typically receives the process variable (PV) from an analog input module and modulates a control variable output (CV) on an analog output module in order to maintain the process variable at the desired setpoint.

The .EN bit indicates execution status. The .EN bit is set when the rung-condition-in transitions from false to true. The .EN bit is cleared when the rung-condition-in becomes false. The PID instruction does not use a .DN bit. The PID instruction executes every scan as long as the rung-condition-in is true.

.EN bit rung state execution of the PID instruction


not affected


IMPORTANT

These faults were major faults in the PLC-5 controller.

A Minor Fault Will Occur If

.UPD

≤

0 setpoint out of range

Fault Type

4

4

Fault Code

35

36



501


Condition


EnableIn is set

Execution:

Action






The instruction executes the PID loop.


Action

No action taken.

na na



The instruction executes the PID loop.

No action taken.

Configure a PID Instruction

After you enter the PID instruction and specify the PID structure, you use the configuration tabs to specify how the PID instruction should function.

Click here to configure the

PID instruction

502




Specify Tuning

In This Field

Setpoint (SP)

Set output %

Output bias

Proportional gain (K p

)

Integral gain (K i

)

Derivative time (K d

)

Manual mode

Select the Tuning tab. Changes take affect as soon as you click on another field, click OK, click Apply, or press Enter.

Specify:

Enter a setpoint value (.SP).

Enter a set output percentage (.SO).

In software manual mode, this value is used for the output.

In auto mode, this value displays the output %.

Enter an output bias percentage (.BIAS).

Enter the proportional gain (.KP).

For independent gains, it’s the proportional gain (unitless).

For dependent gains, it’s the controller gain (unitless).

Enter the integral gain (.KI).

For independent gains, it’s the integral gain (1/sec).

For dependent gains, it’s the reset time (minutes per repeat).

Enter the derivative gain (.KD).

For independent gains, it’s the derivative gain (seconds).

For dependent gains, it’s the rate time minutes).

Select either manual (.MO) or software manual (.SWM).

Manual mode overrides software manual mode if both are selected.



503


Specify Configuration

In this field

PID equation

Control action

Derivative of

Loop update time

CV high limit

CV low limit

Deadband value

No derivative smoothing

No bias calculation

No zero crossing in deadband

PV tracking

Cascade loop

Cascade type

Select the Configuration tab. You must click OK or Apply for any changes to take effect.

Specify

Select independent gains or dependent gains (.PE).

Use independent when you want the three gains (P, I, and D) to operate independently.

Use dependent when you want an overall controller gain that affects all three terms

(P, I, and D).

Select either E=PV-SP or E=SP-PV for the control action (.CA).

Select PV or error (.DOE).

Use the derivative of PV to eliminate output spikes resulting from setpoint changes. Use the derivative of error for fast responses to setpoint changes when the algorithm can tolerate overshoots.

Enter the update time (.UPD) for the instruction.

Enter a high limit for the control variable (.MAXO).

Enter a low limit for the control variable (.MINO).

Enter a deadband value (.DB).

Enable or disable this selection (.NDF).

Enable or disable this selection (.NOBC).

Enable or disable this selection (.NOZC).

Enable or disable this selection (.PVT).

Enable or disable this selection (.CL).

If cascade loop is enabled, select either slave or master (.CT).

504

In This Field

PV high

PV low

PV deadband positive deviation negative deviation deviation deadband

Specifying Alarms

Select the Alarms tab. You must click OK or Apply for any changes to take effect.

Specify

Enter a PV high alarm value (.PVH).

Enter a PV low alarm value (.PVL).

Enter a PV alarm deadband value (.PVDB).

Enter a positive deviation value (.DVP).

Enter a negative deviation value (.DVN).

Enter a deviation alarm deadband value (.DVDB).




Specifying Scaling

In this field

PV unscaled maximum

PV unscaled minimum

PV engineering units maximum

PV engineering units minimum

CV maximum

CV minimum

Tieback maximum

Tieback minimum

PID Initialized

Select the Scaling tab. You must click OK or Apply for any changes to take effect.

Specify

Enter a maximum PV value (.MAXI) that equals the maximum unscaled value received from the analog input channel for the PV value.

Enter a minimum PV value (.MINI) that equals the minimum unscaled value received from the analog input channel for the PV value.

Enter the maximum engineering units corresponding to .MAXI (.MAXS)

Enter the minimum engineering units corresponding to .MINI (.MINS)

Enter a maximum CV value corresponding to 100% (.MAXCV).

Enter a minimum CV value corresponding to 0% (.MINCV).

Enter a maximum tieback value (.MAXTIE) that equals the maximum unscaled value received from the analog input channel for the tieback value.

Enter a minimum tieback value (.MINTIE) that equals the minimum unscaled value received from the analog input channel for the tieback value.

If you change scaling constants during Run mode, turn this off to reinitialize internal descaling values (.INI).

Using PID Instructions

PID closed-loop control holds a process variable at a desired set point. The following figure shows a flow-rate/fluid level example: setpoint flow rate

-

+ error process variable

PID equation control variable level detector

14271

In the above example, the level in the tank is compared against the setpoint. If the level is higher than the setpoint, the PID equation increases the control variable and causes the outlet valve from the tank to open; thereby decreasing the level in the tank.



505


Gains Option

Dependent gains

(ISA standard)

Independent gains

The PID equation used in the PID instruction is a positional form equation with the option of using either independent gains or dependent gains. When using independent gains, the proportional, integral, and derivative gains only affect their specific proportional, integral, or derivative terms respectively.

When using dependent gains, the proportional gain is replaced with a controller gain which affects all three terms. You can use either form of equation to perform the same type of control. The two equation types are merely provided to let you use the equation type with which you are most familiar.

Derivative Of

error (E)

Equation

CV

=

K

C

E

+

T i

∫

0

t

1

+

d dt

+

BIAS

process variable (PV)

E = SP - PV

CV

=

K

C

E

+

1

T i

∫

t

0

–

d dt

+

BIAS

error (E) process variable (PV)

E = PV - SP

CV

=

K

C

E

+

1

T i

∫

t

0

+

d dt

+

BIAS

CV

=

K

P i

∫

t

0

+

d dt

+

BIAS

E = SP - PV

CV

=

K

P

+

i

∫

0

t

–

d dt

+

BIAS

E = PV - SP

CV

=

K

P

+

i

∫

0

t d dt

+

BIAS

506




Where:

Variable

K

P

K i

Description

proportional gain (unitless)

K p

= K c

unitless integral gain (seconds

-1

)

To convert between K i

(integral gain) and T i

(reset time), use:

K d

K

C

T i

T d

SP

PV

E

BIAS

CV dt

K i

= -----------

i

derivative gain (seconds)

To convert between K d

(derivative gain) and T d

(rate time), use:

K d

= K c

(T d

) 60 controller gain (unitless) reset time (minutes/repeat) rate time (minutes) setpoint process variable error [(SP-PV) or (PV-SP)] feedforward or bias control variable loop update time

If you do not want to use a particular term of the PID equation, just set its gain to zero. For example if you want no derivative action, set K d

or T d

equal to zero.

Anti-reset Windup And Bumpless Transfer From Manual To Auto

The PID instruction automatically avoids reset windup by preventing the integral term from accumulating whenever the CV output reaches its maximum or minimum values, as set by .MAXO and .MINO. The accumulated integral term remains frozen until the CV output drops below its maximum limit or rises above its minimum limit. Then normal integral accumulation automatically resumes.



507


The PID instruction supports two manual modes of control:

Manual Mode of Control

software manual (.SWM) manual (.MO)

Description

also known as set output mode lets the user set the output % from the software

The set output (.SO) value is used as the output of the loop. The set output value typically comes from an operator input from an operator interface device.

takes the tieback value, as an input, and adjusts its internal variables to generate the same value at the output

The tieback input to the PID instruction is scaled to 0-100% according to the values of

.MINTIE and .MAXTIE and is used as the output of the loop. The tieback input typically comes from the output of a hardware hand/auto station which is bypassing the output from the controller.

Note: Manual mode overrides software manual mode if both mode bits are set on.

The PID instruction also automatically provides bumpless transfers from software manual mode to auto mode or from manual to auto mode. The PID instruction back-calculates the value of the integral accumulation term required to make the CV output track either the set output (.SO) value in software manual mode or the tieback input in manual mode. In this manner, when the loop switches to auto mode, the CV output starts off from the set output or tieback value and no “bump” in output value occurs.

The PID instruction can also automatically provide a bumpless transfer from manual to auto even if integral control is not used (that is K i

= 0). In this case the instruction modifies the .BIAS term to make the CV output track either the set output or tieback values. When automatic control is resumed, the .BIAS term will maintain its last value. You can disable back-calculation of the .BIAS term by setting the .NOBC bit in the PID data structure. Be aware that if you set .NOBC true, the PID instruction no longer provides a bumpless transfer from manual to auto when integral control is not used.

PID instruction timing

The PID instruction and the sampling of the process variable need to be updated at a periodic rate. This update time is related to the physical process you are controlling. For very slow loops, such as temperature loops, an update time of once per second or even longer is usually sufficient to obtain good control. Somewhat faster loops, such as pressure or flow loops, may require an update time such as once every 250 milliseconds. Only rare cases, such as tension control on an unwinder spool, require loop updates as fast as every 10 milliseconds or faster.

508




Because the PID instruction uses a time base in its calculation, you need to synchronize execution of this instruction with sampling of the process variable

(PV).

The easiest way to execute the PID instruction is to put the PID instruction in a periodic task. Set the loop update time (.UPD) equal to the periodic task rate and make sure that the PID instruction is executed every scan of the periodic task

Relay Ladder

Structured Text

PID(TIC101,Local:0:I.Ch0Data,Local:0:I.Ch1Data,

Local:1:O.Ch4Data,0,Local:1:I.Ch4InHold,

Local:1:I.Ch4Data);

When using a periodic task, make sure that the analog input used for the process variable is updated to the processor at a rate that is significantly faster than the rate of the periodic task. Ideally, the process variable should be sent to the processor at least five to ten times faster than the periodic task rate. This minimizes the time difference between actual samples of the process variable and execution of the PID loop. For example, if the PID loop is in a 250 millisecond periodic task, use a loop update time of 250 milliseconds (.UPD =

.25), and configure the analog input module to produce data at least about every 25 to 50 msecs.

Another, somewhat less accurate, method of executing a PID instruction is to place the instruction in a continuous task and use a timer done bit to trigger execution of the PID instruction.



509


Relay Ladder

Structured Text

PID_timer.pre := 1000

TONR(PID_timer);

IF PID_timer.DN THEN



Local:1:I.Ch0Data);

END_IF;

In this method, the loop update time of the PID instruction should be set equal to the timer preset. As in the case of using a periodic task, you should set the analog input module to produce the process variable at a significantly faster rate than the loop update time. You should only use the timer method of

PID execution for loops with loop update times that are at least several times longer than the worst-case execution time for your continuous task.

The most accurate way to execute a PID instruction is to use the real time sampling (RTS) feature of the 1756 analog input modules. The analog input module samples its inputs at the real time sampling rate you configure when you set up the module. When the module’s real time sample period expires, it updates its inputs and updates a rolling timestamp (represented by the

.RollingTimestamp member of the analog input data structure) produced by the module.

510




The timestamp ranges from 0-32767 milliseconds. Monitor the timestamp.

When it changes, a new process variable sample has been received. Every time a timestamp changes, execute the PID instruction once. Because the process variable sample is driven by the analog input module, the input sample time is very accurate, and the loop update time used by the PID instruction should be set equal to the RTS time of the analog input module.

To make sure that you do not miss samples of the process variable, execute your logic at a rate faster than the RTS time. For example, if the RTS time is

250 msecs, you could put the PID logic in a periodic task that runs every 100 msecs to make sure that you never miss a sample. You could even place the

PID logic in a continuous task, as long as you make sure that the logic would be updated more frequently than once every 250 milliseconds.

An example of the RTS method of execution is shown below. The execution of the PID instruction depends on receiving new analog input data. If the analog input module fails or is removed, the controller stops receiving rolling timestamps and the PID loop stops executing. You should monitor the status bit of the PV analog input and if it shows bad status, force the loop into software manual mode and execute the loop every scan. This lets operator still manually change the output of the PID loop.

Relay Ladder



511


Structured Text

IF (Local:0:I.Ch0Fault) THEN

TIC101.SWM [:=] 1;

ELSE

TIC101.SWM := 0;

END_IF;

IF (Local:0:I.RollingTimestamp<>PreviousTimestamp) OR

(Local:0:I.Ch0Fault) THEN

PreviousTimestamp := Local:0:I.RollingTimestamp;



Local:1:I.Ch0Data);

END_IF;

Bumpless Restart

The PID instruction can interact with the 1756 analog output modules to support a bumpless restart when the controller changes from Program to Run mode or when the controller powers up.

When a 1756 analog output module loses communications with the controller or senses that the controller is in Program mode, the analog output module sets its outputs to the fault condition values you specified when you configured the module. When the controller then returns to Run mode or re-establishes communications with the analog output module, you can have the PID instruction automatically reset its control variable output equal to the analog output by using the Inhold bit and Inhold Value parameters on the PID instruction.

512




To set a bumpless restart:

Do This

Configure the 1756 analog output module’s channel which receives the control variable from the PID instruction

Details:

Select the “hold for initialization” check box on the properties page for the specific channel of the module.

Enter the Inhold bit tag and Inhold Value tag in the

PID instruction

This tells the analog output module that when the controller returns to Run mode or re-establishes communications with the module, the module should hold the analog output at its current value until the value sent from the controller matches (within

0.1% of span) the current value used by the output channel. The controller’s output will ramp to the currently held output value by making use of the .BIAS term. This ramping is similar to auto bumpless transfer.

The 1756 analog output module returns two values for each channel in its input data structure. The InHold status bit (.Ch2InHold, for example), when true, indicates that the analog output channel is holding its value. The Data readback value (.Ch2Data, for example) shows the current output value in engineering units.

Enter the tag of the InHold status bit as the InHold bit parameter of the PID instruction. Enter the tag of the Data readback value as the Inhold Value parameter.

When he Inhold bit goes true, the PID instruction moves the Inhold Value into the

Control variable output and re-initializes to support a bumpless restart at that value.

When the analog output module receives this value back from the controller, it turns off the InHold status bit, which allows the PID instruction to start controlling normally.

Derivative Smoothing

The derivative calculation is enhanced by a derivative smoothing filter. This first order, low pass, digital filter helps to minimize large derivative term spikes caused by noise in the PV. This smoothing becomes more aggressive with larger values of derivative gain. You can disable derivative smoothing if your process requires very large values of derivative gain (K d

> 10, for example). To disable derivative smoothing, select the “No derivative smoothing” option on the Configuration tab or set the .NDF bit in the PID structure.



513


Set the Deadband

The adjustable deadband lets you select an error range above and below the setpoint where output does not change as long as the error remains within this range. This deadband lets you control how closely the process variable matches the setpoint without changing the output. The deadband also helps to minimize wear and tear on your final control device.

+ deadband setpoint

- deadband error within deadband range time

41026

Zero-crossing is deadband control that lets the instruction use the error for computational purposes as the process variable crosses into the deadband until the process variable crosses the setpoint. Once the process variable crosses the setpoint (error crosses zero and changes sign) and as long as the process variable remains in the deadband, the output will not change.

The deadband extends above and below the setpoint by the value you specify.

Enter zero to inhibit the deadband. The deadband has the same scaled units as the setpoint. You can use the deadband without the zero-crossing feature by selecting the “no zero crossing for deadband” option on the Configuration tab or set the .NOZC bit in the PID structure.

If you are using the deadband, the Control variable must be REAL or it will be forced to 0 when the error is within the deadband

Use Output Limiting

You can set an output limit (percentage of output) on the control output.

When the instruction detects that the output has reached a limit, it sets an alarm bit and prevents the output from exceeding either the lower or upper limit.

514




Feedforward or Output Biasing

You can feedforward a disturbance from the system by feeding the .BIAS value into the PID instruction’s feedforward/bias value.

The feedforward value represents a disturbance fed into the PID instruction before the disturbance has a chance to change the process variable.

Feedforward is often used to control processes with a transportation lag. For example, a feedforward value representing “cold water poured into a warm mix” could boost the output value faster than waiting for the process variable to change as a result of the mixing.

A bias value is typically used when no integral control is used. In this case, the bias value can be adjusted to maintain the output in the range required to keep the PV near the setpoint.

Cascading Loops

The PID cascades two loops by assigning the output in percent of the master loop to the setpoint of the slave loop. The slave loop automatically converts the output of the master loop into the correct engineering units for the setpoint of the slave loop, based on the slave loop’s values for .MAXS and

.MINS.

Relay Ladder

Structured Text

PID(master,pv_master,0,cv_master,0,0,0);

PID (slave,pv_slave,0,cv_slave,master,0,0);



515


Control a Ratio

You can maintain two values in a ratio by using these parameters:

• uncontrolled value

• controlled value (the resultant setpoint to be used by the

PID instruction)

• ratio between these two values

Relay Ladder

Structured Text

pid_2.sp := uncontrolled_flow * ratio

PID(pid_2,pv_2,tieback_2,cv_2,0,0,0);

For This Multiplication Parameter

destination source A source B

Enter This Value

controlled value uncontrolled value ratio

516




PID Theory

The following figures show the process flow for a PID instructions.

SP

PID Process

SP

Displayed as EUs

Error

Displayed as EUs

Auto

Manual

PVT

No

Software A/M or

A/M Station Mode

Control

Action

SP-PV

(Error)

+

-

-1

PV-SP

Converts Units to %

Error X 100 maxs-mins

PV

Displayed as EUs

Yes

Converts Binary to

Engineering Units

(PV-mini)(maxs-mins) maxi-mini

+ mins

PID

Calculation

(Out%)

Output

Bias %

Software A/M

Mode

Auto

+

Auto

Set

Output %

Manual

Manual

A/M Station

Mode

Output

Limiting

Output (CV)

Displayed as % of EU Scale

Converts Tieback Units to % tieback-mintie maxtie-mintie x 100

Set

Output %

Convert % to CV Units

CV%(maxcv-mincv)

100

+ mincv

PV

CV

PID Process With Master/slave Loops

Master

Loop

SP

Slave

Loop

(Master.Out)

Software A/M or

A/M Station Mode

Auto

Manual

+

-

PVT

No

Control

Action

SP-PV

(Error)

-1

PV-SP

Converts Units to %


Yes

Converts Binary to

Engineering Units


+ mins

SP

PV

PID

Calculation

(Out%)

Output

Bias %

+

Software A/M

Mode

Auto

Auto

Set

Output %

Manual

Manual

A/M Station

Mode

Output

Limiting

Converts Units to %


Software

A/M Mode

Auto

Manual

Manual

Set

Output %

(Master.Out)

Items referenced in this box are parameters, units, and modes as they pertain to the designated Slave loop.

PV

Converts % to

Engineering Units

X (maxs-mins)

+ mins

100

(SP)

+

-

Converts Binary to

Engineering Units


Control

-1

Action

+ mins

SP-PV

PV-SP

Converts Units to %


PID

Calculation

Output

Bias %

Software A/M

Mode

Auto

+

Auto

A/M Station

Mode

Set

Output %

Manual

Manual

Output

Limiting

Converts Tieback Units to % tieback-mintie maxtie-mintie x 100

Set

Output %

Convert % to CV Units

CV%(maxcv-mincv)

100

+ mincv

PV



517


Notes:

518



Trigonometric Instructions

(SIN, COS, TAN, ASN, ASIN, ACS, ACOS, ATN, ATAN)

Chapter

14

Introduction

If You Want To

Take the sine of a value.

Take the cosine of a value.

Take the tangent of a value.

Take the arc sine of a value.

Take the arc cosine of a value.

Take the arc tangent of a value.

(1)


The trigonometric instructions evaluate arithmetic operations using trigonometric operations.


SIN

COS

TAN

ASN

ASIN

(1)

ACS

ACOS

(1)

ATN

ATAN

(1)


relay ladder structured text function block relay ladder structured text function block relay ladder structured text function block relay ladder structured text function block relay ladder structured text function block relay ladder structured text function block

See Page

520

523

526

529

532

535

You can mix data types, but loss of accuracy and rounding error might occur and the instruction takes more time to execute. Check the overflow status bit

(S:V) to see whether the result was truncated.




519

Chapter 14 Trigonometric Instructions (SIN, COS, TAN, ASN, ASIN, ACS, ACOS, ATN, ATAN)

Sine (SIN)

The SIN instruction takes the sine of the Source value (in radians) and stores the result in the Destination.

dest := SIN(source);

Input Parameter

EnableIn

Source

Data Type

BOOL

REAL

Operands:

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

find the sine of this value tag tag to store the result

Structured Text

Use SIN as a function. This function computes the sine of source and stores the result in dest.


Function Block

Operand

SIN tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

SIN structure


Description


Default is set.

Input to the math instruction.

Valid = any float

520



Trigonometric Instructions (SIN, COS, TAN, ASN, ASIN, ACS, ACOS, ATN, ATAN) Chapter 14

Input Parameter


EnableOut

Dest

Data Type

Data Type

BOOL

REAL

Description:

The Source must be greater than or equal to -205887.4 (-2

π x2

15

) and less than or equal to 205887.4 (2

π x2

15

). The resulting value in the Destination is always greater than or equal to -1 and less than or equal to 1.




none

Execution:

Description

Description



Relay Ladder

Condition:


Action:



The controller calculates the sine of the Source and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



521


Example:

Calculate the sine of value and place the result in result.

Relay Ladder

Structured Text

result := SIN(value);

Function Block

522




Cosine (COS)

dest := COS(source);

Operands:

The COS instruction takes the cosine of the Source value (in radians) and stores the result in the Destination.

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

find the cosine of this value tag tag to store the result

Structured Text

Use COS as a function. This function computes the cosine of source and stores the result in dest.


Function Block

Operand

COS tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

COS structure



523

Chapter 14 Trigonometric Instructions (SIN, COS, TAN, ASN, ASIN, ACS, ACOS, ATN, ATAN) postscan


Input Parameter

EnableIn

Source


EnableOut

Dest

Data Type

BOOL

REAL

Data Type

BOOL

REAL

Description:

The Source must be greater than or equal to -205887.4 (-2

π x2

15


π x2

15

). The resulting value in the Destination is always greater than or equal to -1 and less than or equal to 1.




none

Execution:

Description


Default is set.


Valid = any float

Description



Relay Ladder

Condition


Action



The controller calculates the cosine of the Source and places the result in the Destination.



524



Condition


EnableIn is cleared



Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

Calculate the cosine of value and place the result in result.

Relay Ladder

Structured Text

result := COS(value);

Function Block



525


Tangent (TAN)

dest := TAN(source);

Operands:

The TAN instruction takes the tangent of the Source value (in radians) and stores the result in the Destination.

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

find the tangent of this value tag tag to store the result

Structured Text

Use TAN as a function. This function computes the tangent of source and stores the result in dest.


Function Block

Operand

TAN tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

TAN structure

526




Condition



Input Parameter

EnableIn

Source


EnableOut

Dest

Data Type

BOOL

REAL

Data Type

BOOL

REAL

Description


Default is set.


Valid = any float

Description



Description:

The Source must be greater than or equal to -102943.7(-2

π x2

14


π x2

14

).




none

Execution:

Relay Ladder

Action



The controller calculates the tangent of the Source and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



527


Example:

Calculate the tangent of value and place the result in result.

Relay Ladder

Structured Text

result := TAN(value);

Function Block

528




Arc Sine (ASN)

The ASN instruction takes the arc sine of the Source value and stores the result in the Destination (in radians).

dest := ASIN(source);

Input Parameter

EnableIn

Source

Data Type

BOOL

REAL

Operands:

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

find the arc sine of this value tag tag to store the result

Structured Text

Use ASIN as a function. This function computes the arc sine of source and stores the result in dest.


Function Block

Operand

ASN tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

ASN structure


Description


Default is set.


Valid = any float



529


Input Parameter


EnableOut

Dest

Data Type

Data Type

BOOL

REAL

Description

Description



Description:

The Source must be greater than or equal to -1 and less than or equal to 1. The resulting value in the Destination is always greater than or equal to -

π

/2 and less than or equal to

π

/2 (where

π

= 3.141593).




none

Execution:

Relay Ladder

Condition


Action



The controller calculates the arc sine of the Source and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

530




Example:

Calculate the arc sine of value and place the result in result.

Relay Ladder

Structured Text

result := ASIN(value);

Function Block



531


Arc Cosine (ACS)

The ACS instruction takes the arc cosine of the Source value and stores the result in the Destination (in radians).

dest := ACOS(source);

Input Parameter

EnableIn

Source

Data Type

BOOL

REAL

Operands:

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

find the arc cosine of this value tag tag to store the result

Structured Text

Use ACOS as a function. This function computes the arc cosine of source and stores the result in dest.


Function Block

Operand

ACS tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

ACS structure


Description:


Default is set.


Valid = any float

532




Input Parameter


EnableOut

Dest

Data Type

Data Type

BOOL

REAL

Description:

Description



Description:

The Source must be greater than or equal to -1 and less than or equal to 1. The resulting value in the Destination is always greater than or equal to 0 or less than or equal to

π

(where

π

= 3.141593).




none

Execution:

Relay Ladder

Condition


Action



The controller calculates the arc cosine of the Source and places the result in the Destination.



Function Block

Condition:


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



533


Example:

Calculate the arc cosine of value and place the result in result.

Relay Ladder

Structured Text

result := ACOS(value);

Function Block

534




Arc Tangent (ATN)

The ATN instruction takes the arc tangent of the Source value and stores the result in the Destination (in radians).

dest := ATAN(source);

Input Parameter

EnableIn

Source

Data Type

BOOL

REAL

Operands:

Relay Ladder

Operand: Type

Source SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

find the arc tangent of this value tag tag to store the result

Structured Text

Use ATAN as a function. This function computes the arc tangent of source and stores the result in dest.


Function Block

Operand

ATN tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

ATN structure


Description


Default is set.


Valid = any float



535


Input Parameter


EnableOut

Dest

Data Type

Data Type

BOOL

REAL

Description

Description



Description:

The resulting value in the Destination is always greater than or equal to -

π

/2 and less than or equal to

π

/2 (where

π

= 3.141593).




none

Execution:

Relay Ladder

Condition


Action



The controller calculates the arc tangent of the Source and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

536




Example:

Calculate the arc tangent of value and place the result in result.

Relay Ladder

Structured Text

result := ATAN(value);

Function Block



537


Notes:

538



Chapter

15

Advanced Math Instructions

(LN, LOG, XPY)

Introduction

The advanced math instructions include these instructions:

If You Want To

Take the natural log of a value.

Take the log base 10 of a value.

Raise a value to the power of another value.


LN

LOG

XPY


relay ladder structured text function block relay ladder structured text function block relay ladder structured text

(1) function block

See Page

540

543

546

(1)






539

Chapter 15 Advanced Math Instructions (LN, LOG, XPY)

Natural Log (LN)

The LN instruction takes the natural log of the Source and stores the result in the Destination.

dest := LN(source);

Input Parameter

EnableIn

Source

Operands:

Data Type

BOOL

REAL


EnableOut

Data Type

BOOL

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

find the natural log of this value tag tag to store the result

Structured Text

Use LN as a function. This function computes the natural log of source and stores the result in dest.


Function Block

Operand

LN tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

LN structure


Description


Default is set.

Input to math instruction.

Valid = any float

Description


540



Advanced Math Instructions (LN, LOG, XPY) Chapter 15 postscan

Description:

The Source must be greater than zero, otherwise the overflow status bit (S:V) is set. The resulting Destination is greater than or equal to -87.33655 and less than or equal to 88.72284.




none

Execution:

Relay Ladder

Condition


Action



The controller calculates the natural log of the Source and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



541


Example:

Calculate the natural log of value and place the result in result.

Relay Ladder Example

Structured Text

result := LN(value);

Function Block

542



Advanced Math Instructions (LN, LOG, XPY) Chapter 15

Log Base 10 (LOG)

Operands:

The LOG instruction takes the log base 10 of the Source and stores the result in the Destination.

dest := LOG(source);

Relay Ladder

Operand Type

Source SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

find the log of this value tag tag to store the result

Structured Text

Use LOG as a function. This function computes the log of source and stores the result in dest.


Function Block

Operand

LOG tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

LOG structure



543


Condition



Input Parameter

EnableIn

Source

Data Type

BOOL

REAL


EnableOut

Dest

Data Type

BOOL

REAL

Description


Default is set.

Input to math instruction.

Valid = any float

Description



Description:

The Source must be greater than zero, otherwise the overflow status bit (S:V) is set. The resulting Destination is greater than or equal to -37.92978 and less than or equal to 38.53184.




none

Execution:

Relay Ladder

Action



The controller calculates the log of the Source and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

544



Advanced Math Instructions (LN, LOG, XPY) Chapter 15

Example:

Calculate the log of value and place the result in result.

Relay Ladder

Structured Text

result := LOG(value);

Function Block



545


X to the Power of Y (XPY)

The XPY instruction takes Source A (X) to the power of Source B (Y) and stores the result in the Destination.

Operands:

Relay Ladder

Operand

Source X

Source Y

INT

DINT

REAL

Destination SINT

INT

Type

SINT

INT

DINT

REAL

SINT

DINT

REAL

Format

immediate tag

Description

base value immediate tag exponent tag tag to store the result dest := sourceX ** sourceY;

Structured Text

Use two, adjacent multiply signs “

∗∗

” as an operator within an expression.

This expression takes sourceX to the power of sourceY and stores the result in

dest.


Function Block

Operand

XPY tag

Type

FBD_MATH

Format

structure

Description

XPY structure

546



Advanced Math Instructions (LN, LOG, XPY) Chapter 15 postscan


Input Parameter

EnableIn

Source X

Source Y

Data Type

BOOL

REAL

REAL


EnableOut

Dest

Data Type

BOOL

REAL

Description


Default is set.

Base value.

Valid = any float

Exponent.

Valid = any float

Description



Description:

If Source X is negative, Source Y must be an integer value or a minor fault will occur.

The XPY instruction uses this algorithm: Destination = X**Y

The controller evaluates x

0

=1 and 0 x

=0.





Source X is negative and Source Y is not an integer value

Fault Type

4

Fault Code

4

Execution:

Relay Ladder

Condition


Action



The controller takes Source X to the power of Source Y and places the result in the Destination.





547


Condition


EnableIn is cleared


Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

The XPY instruction takes value_1 to the power of value_2 and places the result in result.

Relay Ladder

Structured Text

result := (value_1

∗∗

value_2);

Function Block

548



Chapter

16

Math Conversion Instructions

(DEG, RAD, TOD, FRD, TRN, TRUNC)

Introduction

If You Want To

Convert radians to degrees.

Convert degrees to radians.

Convert an integer value to a BCD value.

Convert a BCD value to an integer value.

Remove the fractional part of a value

The math conversion instructions convert values.


DEG

RAD

TOD

FRD

TRN

TRUNC

(1)


relay ladder structured text function block relay ladder structured text function block relay ladder function block relay ladder function block relay ladder structured text function block

See Page

550

553

556

559

561

(1)






549

Chapter 16 Math Conversion Instructions (DEG, RAD, TOD, FRD, TRN, TRUNC)

Degrees (DEG)

The DEG instruction converts the Source (in radians) to degrees and stores the result in the Destination.

dest := DEG(source);

Input Parameter

EnableIn

Source

Data Type

BOOL

REAL

Operands:

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

value to convert to degrees tag tag to store the result

Structured Text

Use DEG as a function. This function converts source to degrees and stores the result in dest.


Function Block

Operand

DEG tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

DEG structure


Description


Default is set.

Input to the conversion instruction.

Valid = any float

550



Math Conversion Instructions (DEG, RAD, TOD, FRD, TRN, TRUNC) Chapter 16

Input Parameter


EnableOut

Dest

Data Type

Data Type

BOOL

REAL

Description

Description


Result of the conversion instruction. Arithmetic status flags are set for this output.

Description:

The DEG instruction uses this algorithm:

Source*180/

π

(where

π

= 3.141593)




none

Execution:

Relay Ladder

Condition


Action



The controller converts the Source to degrees and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.



551


Example:

Convert value to degrees and place the result in result.

Relay Ladder

Structured Text

result := DEG(value);

Function Block

552




Radians (RAD)

The RAD instruction converts the Source (in degrees) to radians and stores the result in the Destination.

dest := RAD(source);

Input Parameter

EnableIn

Source

Data Type

BOOL

REAL

Operands:

Relay Ladder

Operand

Source

Type

SINT

INT

DINT

REAL

Destination SINT

INT

DINT

REAL

Format

immediate tag

Description

value to convert to radians tag tag to store the result

Structured Text

Use RAD as a function. This function converts source to radians and stores the result in dest.


Function Block

Operand

RAD tag

Type

FBD_MATH_ADVANCED

Format

structure

Description

RAD structure


Description


Default is set.


Valid = any float



553


Input Parameter


EnableOut

Dest

Data Type

Data Type

BOOL

REAL

Description

Description



Description:

The RAD instruction uses this algorithm:

Source*

π

/180 (where

π

= 3.141593)




none

Execution:

Relay Ladder

Condition


Action



The controller converts the Source to radians and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

554




Example

Convert value to radians and place the result in result.

Relay Ladder

Structured Text

result := RAD(value);

Function Block



555


Convert to BCD (TOD)

The TOD instruction converts a decimal value

(0

≤

Source

≤

to a

BCD value and stores the result in the Destination.

Operands:

Relay Ladder

Operand

Source

Destination

Type

SINT

INT

Format

immediate tag

Description

value to convert to decimal

DINT



INT

DINT

Function Block

Operand

TOD tag

Type

FBD_CONVERT

FBD_CONVERT Structure

Format

structure

Description

TOD structure

Input Parameter

EnableIn

Source

Data Type

BOOL

DINT


EnableOut

Dest

Data Type

BOOL

DINT

Description


Default is set.


Valid = any integer

Description



Description:

BCD is the Binary Coded Decimal number system that expresses individual decimal digits (0-9) in a 4-bit binary notation.

If you enter a negative Source, the instruction generates a minor fault and clears the Destination.



556






Source < 0

Condition


Execution:

Relay Ladder

Action



Fault Type

4

Fault Code

4 source < 0

S:V is set to 1 yes no source > 99,999,999 no yes convert source to BCD rung-condition-in is true postscan

Condition

prescan instruction first scan instruction first run rung-condition-out is set to true end

The controller converts the Source to BCD and places the result in the Destination.



Function Block

Action

No action taken.

No action taken.

No action taken.



557


Condition

EnableIn is cleared


Action



EnableOut is set.

No action taken.

Example:

The TOD instruction converts value_1 to a BCD value and places the result in

result_a.

Relay Ladder

Function Block

558




Convert to Integer (FRD)

The FRD instruction converts a BCD value (Source) to a decimal value and stores the result in the Destination.

Operands:

Relay Ladder

Operand

Source

Destination

Type

SINT

INT

Format

immediate tag

Description

value to convert to decimal

DINT



INT

DINT

Function Block

Operand

FRD tag

Type

FBD_CONVERT

FBD_CONVERT Structure

Format:

structure

Description

FRD structure

Input Parameter

EnableIn

Source

Data Type

BOOL

DINT


EnableOut

Dest

Data Type

BOOL

DINT

Description


Default is set.


Valid = any integer

Description



Description:

The FRD instruction converts a BCD value (Source) to a decimal value and stores the result in the Destination.




none



559


Condition


Condition


EnableIn is cleared


Execution:

Relay Ladder

Action



The controller converts the Source to a decimal value and places the result in the Destination.



Function Block

Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

Example:

The FRD instruction converts value_a to a decimal value and places the result in result_1.

Relay Ladder

Function Block

560




Truncate (TRN)

The TRN instruction removes (truncates) the fractional part of the Source and stores the result in the Destination.

dest := TRUNC(source);

Input Parameter

EnableIn

Source

Operands:

Data Type

BOOL

REAL


EnableOut

Dest

Data Type

BOOL

DINT

Relay Ladder

Operand

Source

Type

REAL

Format

immediate tag tag

Description

value to truncate tag to store the result Destination SINT

INT

DINT

REAL

Structured Text

Use TRUNC as a function. This function truncates source and stores the result in dest.


Function Block

Operand

TRN tag

Type

FBD_TRUNCATE

Format

structure

Description

TRN structure

FBD_TRUNCATE Structure

Description


Default is set.


Valid = any float

Description





561

Chapter 16 Math Conversion Instructions (DEG, RAD, TOD, FRD, TRN, TRUNC) postscan

Description:

Truncating does not round the value; rather, the non-fractional part remains the same regardless of the value of the fractional part.




none

Execution:

Relay Ladder

Condition


Action



The controller removes the fractional part of the Source and places the result in the Destination.



Function Block

Condition


EnableIn is cleared


Action

No action taken.

No action taken.

No action taken.



EnableOut is set.

No action taken.

562




Example:

Remove the fractional part of float_value_1, leaving the non-fractional part the same, and place the result in float_value_1_truncated.

Relay Ladder

Structured Text

float_value_1_truncated := TRUNC(float_value_1);

Function Block



563


Notes:

564



Chapter

17

ASCII Serial Port Instructions

(ABL, ACB, ACL, AHL, ARD, ARL, AWA, AWT)

Introduction

Use the ASCII serial port instructions to read and write ASCII characters.

IMPORTANT

To use the ASCII serial port instructions, you must configure the serial port of the controller. See the Logix5000 Controllers

Common Procedures, publication 1756-PM001.

If You Want To For Example

determine when the buffer contains termination characters check for data that contains termination characters count the characters in the buffer check for the required number of characters before reading the buffer clear the buffer clear out ASCII Serial Port instructions that are currently executing or are in the queue obtain the status of the serial port control lines turn on or off the DTR signal turn on or off the RTS signal read a fixed number of characters

• remove old data from the buffer at start-up

• synchronize the buffer with a device cause a modem to hang up read a varying number of characters, up to and including the first set of termination characters send characters and automatically append one or two additional characters to mark the end of the data send characters read data from a device that sends the same number of characters each transmission read data from a device that sends a varying number of characters each transmission send messages that always use the same termination character(s) send messages that use a variety of termination characters

Use This

Instruction

ABL

ACB

ACL

AHL

ARD

ARL

AWA

AWT

Available In These

Languages

relay ladder

See Page

570 structured text relay ladder structured text relay ladder structured text

573

575

577 relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text

581

585

589

594



565

Chapter 17 ASCII Serial Port Instructions (ABL, ACB, ACL, AHL, ARD, ARL, AWA, AWT)

Instruction Execution

ASCII serial port instructions execute asynchronous to the scan of the logic:

Logic

Rung-condition-in of instruction transitions from false to true

Instruction enters the

ASCII queue.

ASCII Queue

Instruction 1

Instruction 2

Instruction 3

Instruction 4

ASCII Task

Instruction at the top of the queue executes.

Data flows between task and buffer.

Data flows between buffer and serial port.

Serial Port

Buffer

Each ASCII serial port instruction (except ACL) uses a

SERIAL_PORT_CONTROL structure to perform the following functions:

• control the execution of the instruction

• provide status information about the instruction

566



ASCII Serial Port Instructions (ABL, ACB, ACL, AHL, ARD, ARL, AWA, AWT) Chapter 17

The following timing diagram depicts the changes in the status bits as an ABL instruction tests the buffer for termination characters.

scan scan scan scan rung-condition-in false true

.EN

.EU

off off on on

.RN

.DN or .ER

.FD

.EM

off off off off on off on on false off true on off off off on off on on false off on on enters queue resets status bits executes in this example, finds termination characters when scanned and .DN or .ER are set, sets the

.EM bit

The ASCII queue holds up to 16 instructions. When the queue is full, an instruction tries to enter the queue on each subsequent scan of the instruction, as depicted below: scan scan scan scan

.EN

.EU

rung-condition-in false true on off off false on attempts to enter queue but queue is full enters queue



567


ASCII Error Codes

If an ASCII serial port instruction fails to execute, the ERROR member of its

SERIAL_PORT_CONTROL structure will contain one of the following hexadecimal error codes:

This Hex Code Indicates That the

16#2

16#3

Modem went offline.

CTS signal was lost during communication.

16#4

16#A

16#C

16#D

Serial port was in system mode.

Before the instruction executed, the .UL bit was set. This prevents the execution of the instruction.

The controller changed from Run mode to Program mode. This stops the execution of an ASCII serial port instruction and clears the queue.

In the Controller Properties dialog box, User Protocol tab, the buffer size or echo mode parameters were changed and applied. This stops the execution of an ASCII serial port instruction and clears the queue.

16#E

16#F

16#51

16#54

16#55

ACL instruction executed.

Serial port configuration changed from User mode to System mode. This stops the execution of an ASCII serial port instruction and clears the ASCII serial port instruction queue.

The LEN value of the string tag is either negative or greater than the DATA size of the string tag.

The Serial Port Control Length is greater than the size of the buffer.

The Serial Port Control Length is either negative or greater than the size of the Source or Destination.

String Data Types

You store ASCII characters in tags that use a string data type.

•

You can use the default STRING data type. It stores up to 82 characters.

•

You can create a new string data type that stores less or more characters.

To create a new string data type, see Logix5000 Controllers Common Procedures, publication 1756-PM001.

Each string data type contains the following members:

568




Name

LEN

Data Type

DINT

DATA SINT array

Description

number of characters in the string

ASCII characters of the string

Notes

The LEN automatically updates to the new count of characters whenever you:

• use the String Browser dialog box to enter characters

• use instructions that read, convert, or manipulate a string

The LEN shows the length of the current string. The DATA member may contain additional, old characters, which are not included in the LEN count.

•

To access the characters of the string, address the name of the tag.

For example, to access the characters of the string_1 tag, enter string_1.

•

Each element of the DATA array contains one character.

•

You can create new string data types that store less or more characters.



569


ASCII Test For Buffer Line

(ABL)

Operands:

The ABL instruction counts the characters in the buffer up to and including the first termination character.

Relay Ladder

ABL


?

Channel

SerialPort Control

Character Count ?

EN

DN

?

ER

Operand

Channel

Serial Port

Control

Character

Count

Type

DINT

Format

immediate

Description

0

SERIAL_PORT_

CONTROL

DINT tag tag tag that controls the operation immediate 0

ABL(Channel

SerialPortControl);

.RN

.EM

.ER

.FD

.POS

Mnemonic

.EN

.EU

.DN

.ERROR

Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

During execution, displays the number of characters in the buffer, including the first set of termination characters.

Structured Text

The operands are the same as those for the relay ladder ABL instruction. You access the Character Count value via the .POS member of the

SERIAL_PORT_CONTROL structure.

SERIAL_PORT_CONTROL Structure

Description

The enable bit indicates that the instruction is enabled.

The queue bit indicates that the instruction entered the ASCII queue.

The done bit indicates when the instruction is done, but it is asynchronous to the logic scan.

The run bit indicates that the instruction is executing.

The empty bit indicates that the instruction is done, but it is synchronous to the logic scan.

The error bit indicates when the instruction fails (errors).

The found bit indicates that the instruction found the termination character or characters.

The position determines the number of characters in the buffer, up to and including the first set of termination characters. The instruction only returns this number after it finds the termination character or characters.

The error contains a hexadecimal value that identifies the cause of an error.

570




Description

The ABL instruction searches the buffer for the first set of termination characters. If the instruction finds the termination characters, it:

• sets the .FD bit

• counts the characters in the buffer up to and including the first set of termination characters

The Controller Properties dialog box, User Protocol tab, defines the ASCII characters that the instruction considers as the termination characters.

To program the ABL instruction, follow these guidelines:

1.

Configure the serial port of the controller for user mode and define the characters that serve as the termination characters.

2.


•


•

In structured text, condition the instruction so that it only executes on a transition.


not affected


none

Execution:

Condition






The instruction executes when rung-condition-in toggles from cleared to set.


na


No action taken.

na na



The instruction counts the characters in the buffer.

The .EN bit is set.

The remaining status bits, except .UL, are cleared.

The instruction attempts to enter the ASCII queue.


No action taken.



571


MV_line.EN

/

Example:

Continuously test the buffer for the termination characters.

Relay Ladder

ABL


Channel

SerialPort Control

0

MV_line

Character Count 0

EN

DN

ER

Structured Text

ABL(0,MV_line);

572




ACB(Channel

SerialPortControl);

Mnemonic

.EN

.EU

.DN

.RN

.EM

.ER

.FD

.POS

.ERROR

ASCII Chars in Buffer (ACB)

The ACB instruction counts the characters in the buffer.

Operands:

ACB


Channel

SerialPort Control

Character Count

?

?

EN

DN

Relay Ladder

Operand

Channel

Type

DINT

Serial Port

Control

Character

Count

SERIAL_PORT_

CONTROL

DINT

Format

immediate

Enter

0 tag tag tag that controls the operation immediate 0

Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

During execution, displays the number of characters in the buffer.

Structured Text

The operands are the same as those for the relay ladder ACB instruction.

However, you specify the Character Count value by accessing the .POS member of the SERIAL_PORT_CONTROL structure, rather than by including the value in the operand list.


Description







The found bit indicates that the instruction found a character.

The position determines the number of characters in the buffer, up to and including the first set of termination characters.




573


Description:

The ACB instruction counts the characters in the buffer.

To program the ACB instruction, follow these guidelines:

1.

Configure the serial port of the controller for user mode.

2.


•


•



not affected


none

Execution:

Condition








na


No action taken.

na na



The instruction counts the characters in the buffer.

The .EN bit is set.




No action taken.

Example:

Continuously count the characters in the buffer.

Relay Ladder

bar_code_count.EN

/

ACB


Channel

SerialPort Control

Character Count

0

0

EN

DN

Structured Text

ACB(0,bar_code_count);

574




ASCII Clear Buffer (ACL)

The ACL instruction immediately clears the buffer and ASCII queue.

Operands:

Relay Ladder

ACL

ASCII Clear Buffer

Channel

Clear Serial Port Read

Clear Serial Port Write

?

Operand

Channel

Type

DINT

Clear Serial

Port Read

BOOL

Clear Serial

Port Write

BOOL

Format

immediate tag immediate tag immediate tag

Enter

0

To empty the buffer and remove ARD and

ARL instructions from the queue, enter Yes.

To remove AWA and AWT instructions from the queue, enter Yes.

ACL(Channel,

ClearSerialPortRead,

ClearSerialPortWrite);

Structured Text

The operands are the same as those for the relay ladder ACL instruction.

Description:

The ACL instruction immediately performs one or both of the following actions:

• clears the buffer of characters and clears the ASCII queue of read instructions

• clears the ASCII queue of write instructions

To program the ACL instruction, follow these guidelines:

1.

Configure the serial port of the controller:

If Your Application

uses ARD or ARL instructions

does not use ARD or ARL instructions

Then

Select User mode

Select either System or User mode

2.

To determine if an instruction was removed from the queue or aborted, examine the following of the appropriate instruction:

•

.ER bit is set

•

.ERROR member is 16#E


not affected


none



575


Execution:

Condition








na


No action taken.

na na



The instruction clears the specified instructions and buffer(s).


No action taken.

Example:

When the controller enters Run mode, clear the buffer and the ASCII queue.

Relay Ladder

S:FS

Structured Text

osri_1.InputBit := S:FS;

OSRI(osri_1);

IF (osri_1.OutputBit) THEN

ACL(0,0,1);

END_IF;

ACL

ASCII Clear Buffer

Channel 0

Clear Serial Port Read 1

Clear Serial Port Write 1

576




ASCII Handshake Lines

(AHL)

Operands:

The AHL instruction obtains the status of control lines and turns on or off the

DTR and RTS signals.

Relay Ladder

AHL


Channel

AND Mask

OR Mask

SerialPort Control

Channel Status(Decimal)

?

?

??

?

??

EN

?

?

DN

ER

Operand

Channel

ANDMask

ORMask

Serial Port Control

Channel Status (Decimal)

Type

DINT

DINT

Format

immediate tag immediate

DINT tag immediate tag

SERIAL_PORT_CONTROL tag

DINT immediate

Enter

0

Refer to the description.

tag that controls the operation

0

AHL(Channel,ANDMask,ORMask,

SerialPortControl);

During execution, displays the status of the control lines.

For the Status Of This Control

Line

Examine This Bit:

CTS 0

RTS 1

DSR

DCD

DTR

Received the XOFF character

2

3

4

5

Structured Text

The operands are the same as those for the relay ladder AHL instruction.

However, you specify the Channel Status value by accessing the .POS member of the SERIAL_PORT_CONTROL structure, rather than by including the value in the operand list.



577

Mnemonic

.EN

.EU

.DN

.RN

.EM

.ER

.FD

.POS

.ERROR



Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

Description







The found bit does not apply to this instruction.

The position stores the status of the control lines.


Description:

The AHL instruction can:

• obtain the status of the control lines of the serial port

• turn on or off the data terminal ready (DTR) signal

• turn on or off the request to send signal (RTS)

To program the AHL instruction, follow these guidelines:

1.





Then

Select User mode


2.

Use the following table to select the correct values for the ANDMask and ORMask operands:

To Turn DTR And Turn RTS: Enter This

ANDMask Value

off off 3 on on unchanged off

1

1

2 unchanged on unchanged off on unchanged

2

0

0

0

0

0

2

3

1

0

2

0

1

And Enter This

ORMask Value

0

578




3.


•


•



not affected


Type

4

Code

57

Cause

The AHL instruction failed to execute because the serial port is set to no handshaking.

Recovery Method

Either:

•

Change the Control Line setting of the serial port.

•

Delete the AHL instruction.

Execution:

Condition








No action taken.

na na




The instruction obtains the control line status and turns on or off DTR and RTS signals.

The .EN bit is set.




No action taken.



579


Example:

When get_control_line_status becomes set, obtain the status of the control lines of the serial port and store the status in the Channel Status operand. To view the status of a specific control line, monitor the SerialPortControl tag and expand the POS member.

Relay Ladder

get_control_line_status AHL


Channel

AND Mask

OR Mask

0

0

0

SerialPort Control serial_port

Channel Status(Decimal) 29

EN

DN

ER

Structured Text

osri_1.InputBit := get_control_line_status;

OSRI(osri_1);


AHL(0,0,0,serial_port);

END_IF;

580




ASCII Read (ARD)

Operands:

The ARD instruction removes characters from the buffer and stores them in the Destination.

Relay Ladder

ARD

Channel

Destination

?

??

SerialPort Control

SerialPort Control Length

Characters Read

?

?

DN

?

ER

?

Operand

Channel

Destination

Type

DINT

string

SINT

INT

DINT

Serial Port

Control

Serial Port

Control Length

SERIAL_PORT_

CONTROL

DINT tag immediate

Characters Read DINT

ARD(Channel,Destination,

SerialPortControl);

Format

immediate tag tag immediate

Enter

0

Notes

tag into which the characters are moved

(read):

•

For a string data type, enter the name of the tag.

•

For a SINT, INT, or DINT array, enter the first element of the array.


•

If you want to compare, convert, or manipulate the characters, use a string data type.

•


• default STRING data type

• any new string data type that you create number of characters to move to the destination

(read)

0

•

The Serial Port Control Length must be less than or equal to the size of the Destination.

•

If you want to set the Serial Port Control

Length equal to the size of the Destination, enter 0.

During execution, displays the number of characters that were read.

Structured Text

The operands are the same as those for the relay ladder ARD instruction.

However, you specify the Serial Port Control Length and the Characters Read values by accessing the .LEN and .POS members of the

SERIAL_PORT_CONTROL structure, rather than by including the values in the operand list.



581



Mnemonic

.EN

.EU

.DN

.RN

.EM

.ER

.FD

.LEN

.POS

.ERROR

Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

DINT

Description








The length indicates the number of characters to move to the destination (read).

The position displays the number of characters that were read.


Description:

The ARD instruction removes the specified number of characters from the buffer and stores them in the Destination.

•

The ARD instruction continues to execute until it removes the specified number of characters (Serial Port Control Length).

•

While the ARD instruction is executing, no other ASCII Serial Port instruction executes.

To program the ARD instruction, follow these guidelines:

1.

Configure the serial port of the controller for user mode.

2.

Use the results of an ACB instruction to trigger the ARD instruction.

This prevents the ARD instruction from holding up the ASCII queue while it waits for the required number of characters.

3.


•


•


4.

To trigger a subsequent action when the instruction is done, examine the EM bit.


not affected


none

582




Condition



Execution:






No action taken.

na na




The instruction removes characters from the buffer and stores them in the destination.

The .EN bit is set.




No action taken.

Example:

A bar code reader sends bar codes to the serial port (channel 0) of the controller. Each bar code contains 24 characters. To determine when the controller receives a bar code, the ACB instruction continuously counts the characters in the buffer. When the buffer contains at least 24 characters, the controller has received a bar code. The ARD instruction moves the bar code to the DATA member of the bag_bar_code tag, which is a string.

Relay Ladder

bar_code_count.EN

/

ACB


Channel

SerialPort Control

Character Count

0

0

EN

DN

GEQ

Grtr Than or Eql (A>=B)

Source A bar_code_count.pos

0

Source B 24

ARD

ASCII Read

Channel

Destination

0 bag_bar_code

SerialPort Control


Characters Read

''

0

EN

DN

24



583


Structured Text

ACB(0,bar_code_count);

IF bar_code_count.POS >= 24 THEN bar_code_read.LEN := 24;

ARD(0,bag_bar_code,bar_code_read);

END_IF;

584




ASCII Read Line (ARL)

The ARL instruction removes specified characters from the buffer and stores them in the Destination.

Operands:

Relay Ladder

ASCII Read Line

Channel

Destination

ARL

?

??

SerialPort Control


Characters Read

?

?

EN

DN

?

ER

?

Operand

Channel

Destination

Type

DINT

string

SINT

INT

DINT

Serial Port

Control

Serial Port

Control Length

SERIAL_PORT_

CONTROL

DINT tag immediate

Characters Read DINT

ARL(Channel,Destination,

SerialPortControl);

Format


Enter

0

Notes

tag into which the characters are moved

(read):

•


•



•


•



• any new string data type that you create maximum number of characters to read if no termination characters are found

0

•

Enter the maximum number of characters that any message will contain (that is, when to stop reading if no termination characters are found).

For example, if messages range from 3 to 6 characters in length, enter 6.

•

The Serial Port Control Length must be less than or equal to the size of the Destination.

•


Length equal to the size of the Destination, enter 0.

During execution, displays the number of characters that were read.

Structured Text

The operands are the same as those for the relay ladder ARL instruction.

However, you specify the Serial Port Control Length and the Characters Read values by accessing the .LEN and .POS members of the



585

Mnemonic

.EN

.EU

.DN

.RN

.EM

.ER

.FD

.LEN

.POS

.ERROR




Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

DINT

Description








The length indicates the maximum number of characters to move to the destination (that is, when to stop reading if no termination characters are found).

The position displays the number of characters that were read.


Description:

The ARL instruction removes characters from the buffer and stores them in the Destination as follows:

•

The ARL instruction continues to execute until it removes either the:

–

first set of termination characters

–

specified number of characters (Serial Port Control Length)

•

While the ARL instruction is executing, no other ASCII serial port instruction executes.

To program the ARL instruction, follow these guidelines:

1.

Configure the serial port of the controller: a. Select User mode.

b. Define the characters that serve as the termination characters.

2.

Use the results of an ABL instruction to trigger the ARL instruction.

This prevents the ARL instruction from holding up the ASCII queue while it waits for the termination characters.

3.


•


•


586




4.

To trigger a subsequent action when the instruction is done, examine the EM bit.


not affected


none

Execution:

Condition








No action taken.

na na




The instruction removes the specified characters from the buffer and stores them in the destination.

The .EN bit is set.




No action taken.

Example:

Continuously test the buffer for a message from a MessageView terminal.

Since each message ends in a carriage return ($r), the carriage return is configured as the termination character in the Controller Properties dialog box, User Protocol tab. When the ABL finds a carriage return, its sets the FD bit.

When the ABL instruction finds the carriage return (MV_line.FD is set), the controller has received a complete message. The ARL instruction removes the characters from the buffer, up to and including the carriage return, and places them in the DATA member of the MV_msg tag, which is a string.



587


MV_line.EN

/

MV_line.FD

Relay Ladder

ABL


Channel

SerialPort Control

0

MV_line

Character Count 0

EN

DN

ER

ASCII Read Line

Channel

Destination

ARL

SerialPort Control


Characters Read

0

MV_msg

''

MV_read

12

0

EN

DN

ER

Structured Text

ABL(0,MV_line); osri_1.InputBit := MVLine.FD;

OSRI(osri_1);

IF (osri_1.OutputBit) THEN mv_read.LEN := 12;

ARL(0,MV_msg,MV_read);

END_IF;

588




ASCII Write Append (AWA)

The AWA instruction sends a specified number of characters of the Source tag to a serial device and appends either one or two predefined characters.

Operands:

Relay Ladder

AWA

Channel

Source

?

?

??

SerialPort Control


Characters Sent ?

DN

?

ER

?

Operand

Channel

Source

Type

DINT

string

SINT

INT

DINT

Serial Port

Control

Serial Port

Control Length

SERIAL_PORT_

CONTROL

DINT tag immediate

Characters Sent DINT

AWA(Channel,Source,

SerialPortControl);

Format


Enter

0

Notes

tag that contains the characters to send:

•


•



•


•



• any new string data type that you create number of characters to send

0

•

The Serial Port Control Length must be less than or equal to the size of the Source.

•


Length equal to the number of characters in the Source, enter 0.

During execution, displays the number of characters that were sent.

Structured Text

The operands are the same as those for the relay ladder AWA instruction.

However, you specify the Serial Port Control Length and the Characters Sent values by accessing the .LEN and .POS members of the




589

Mnemonic

.EN

.EU

.DN

.RN

.EM

.ER

.FD

.LEN

.POS

.ERROR



Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

DINT

Description








The length indicates the number of characters to send.

The position displays the number of characters that were sent.


Description:

The AWA instruction:

• sends the specified number of characters (Serial Port Control Length) of the Source tag to the device that is connected to the serial port of the controller

• adds to the end of the characters (appends) either one or two characters that are defined in the Controller Properties dialog box, User Protocol tab

To program the AWA instruction, follow these guidelines:

1.

Configure the serial port of the controller: a. Does your application also include ARD or ARL instructions?

If

Yes

No

Then

Select User mode

Select either System or User mode b. Define the characters to append to the data.

2.


•


•


590




3.

Each time the instruction executes, do you always send the same number of characters?

If

Yes

No

Then

In the Serial Port Control Length, enter the number of characters to send.

Before the instruction executes, set the LEN member of the Source tag to the LEN member of the Serial Port Control tag.


not affected


none

Execution:

Condition








No action taken.

na na




The instruction sends a specified number of characters and appends either one or two predefined characters.

The .EN bit is set.




No action taken.



591

Chapter 17 ASCII Serial Port Instructions (ABL, ACB, ACL, AHL, ARD, ARL, AWA, AWT) temp_high

Example 1:

When the temperature exceeds the high limit (temp_high is set), the AWA instruction sends a message to a MessageView terminal that is connected to the serial port of the controller. The message contains five characters from the

DATA member of the string[1] tag, which is a string. (The $14 counts as one character. It is the hex code for the Ctrl-T character.) The instruction also sends (appends) the characters defined in the controller properties. In this example, the AWA instruction sends a carriage return ($0D), which marks the end of the message.

Relay Ladder

AWA

ASCII Write Append

Channel

Source

SerialPort Control


Characters Sent

0 string[1]

'$1425\1' temp_high_write

5

6

EN

DN

ER

Structured Text

IF temp_high THEN temp_high_write.LEN := 5;

AWA(0,string[1],temp_high_write); temp_high := 0;

END_IF;

592



alarm


Example 2:

When alarm is set, the AWA instruction sends the specified number of characters in alarm_msg and appends a termination character (s). Because the number of characters in alarm_msg varies, the rung first moves the length of the string (alarm_msg.LEN) to the Serial Port Control Length of the AWA instruction (alarm_write.LEN). In alarm_msg, the $14 counts as one character. It is the hex code for the Ctrl-T character.

Relay Ladder

MOV

Move

Source alarm_msg.LEN

Dest

5 alarm_write.LEN

5

AWA

ASCII Write Append

Channel 0

Source

SerialPort Control

SerialPort Control Length alarm_msg

'$1425\1' alarm_write

5

Characters Sent 6

EN

DN

ER

Structured Text

osri_1.InputBit := alarm;

OSRI(osri_1);

IF (osri_1.OutputBit) THEN alarm_write.LEN := alarm_msg.LEN;

AWA(0,alarm_msg,alarm_write);

END_IF;



593


ASCII Write (AWT)

Operands:

The AWT instruction sends a specified number of characters of the Source tag to a serial device.

Relay Ladder

AWT

ASCII Write

Channel

Source

?

?

??

SerialPort Control


Characters Sent ?

EN

DN

?

ER

?

Operand

Channel

Source

Type

DINT

string

SINT

INT

DINT

Serial Port

Control

Serial Port

Control Length

SERIAL_PORT_

CONTROL

DINT tag immediate

Characters Sent DINT

AWT(Channel,Source,

SerialPortControl);

Format


Enter

0

Notes

tag that contains the characters to send:

•


•



•


•



• any new string data type that you create number of characters to send

0

•

The Serial Port Control Length must be less than or equal to the size of the Source.

•


Length equal to the number of characters in the Source, enter 0.

During execution, displays the number of characters that were sent.

Structured Text

The operands are the same as those for the relay ladder AWT instruction.

However, you specify the Serial Port Control Length and the Characters Sent values by accessing the .LEN and .POS members of the

SERIAL_PORT_CONTROL structure, rather than by including the values in the operand list

594



Mnemonic

.EN

.EU

.DN

.RN

.EM

.ER

.FD

.LEN

.POS

.ERROR



Data Type

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

BOOL

DINT

DINT

DINT

Description








The length indicates the number of characters to send.

The position displays the number of characters that were sent.


Description:

The AWT instruction sends the specified number of characters (Serial Port

Control Length) of the Source tag to the device that is connected to the serial port of the controller.

To program the AWT instruction, follow these guidelines:

1.





Then

Select User mode


2.


•


•


3.

Each time the instruction executes, do you always send the same number of characters?

If

Yes

No

Then

In the Serial Port Control Length, enter the number of characters to send.

Before the instruction executes, move the LEN member of the Source tag to the LEN member of the Serial Port Control tag.



595



not affected


none

Execution:

Condition








No action taken.

na na



The instruction sends a specified number of characters.


The .EN bit is set.




No action taken.

Example 1:

When the temperature reaches the low limit (temp_low is set), the AWT instruction sends a message to the MessageView terminal that is connected to the serial port of the controller. The message contains nine characters from the

DATA member of the string[2] tag, which is a string. (The $14 counts as one character. It is the hex code for the Ctrl-T character.) The last character is a carriage return ($r), which marks the end of the message.

Relay Ladder

temp_low AWT

ASCII Write

Channel 0

Source string[2]

'$142224\01$r'

SerialPort Control

SerialPort Control Length temp_low_write

9

Characters Sent 9

EN

DN

ER

596




MV_update

Structured Text

osri_1.InputBit := temp_low;

OSRI(osri_1);

IF (osri_1.OutputBit) THEN temp_low_write.LEN := 9;

AWT(0,string[2],temp_low_write);

END_IF;

Example 2:

When MV_update is set, the AWT instruction sends the characters in MV_msg.

Because the number of characters in MV_msg varies, the rung first moves the length of the string (MV_msg.LEN) to the Serial Port Control Length of the

AWT instruction (MV_write.LEN). In MV_msg, the $16 counts as one character. It is the hex code for the Ctrl-V character.

Relay Ladder

MOV

Move

Source MV_msg.LEN

10

Dest MV_write.LEN

10

AWT

ASCII Write

Channel

Source

0

MV_msg

'$161365\8\1$r'

MV_write SerialPort Control


Characters Sent

10

10

EN

DN

ER

Structured Text

osri_1.InputBit := MV_update;

OSRI(osri_1);


MV_write.LEN := Mv_msg.LEN;

AWT(0,MV_msg,MV_write);

END_IF;



597


Notes:

598



Chapter

18

ASCII String Instructions

(CONCAT, DELETE, FIND, INSERT, MID)

Introduction

Use the ASCII string instructions to modify and create strings of

ASCII characters.

If you want to

delete characters from a string

For example

add characters to the end of a string add termination characters or delimiters to a string determine the starting character of a sub-string locate a group of characters within a string insert characters into a string extract characters from a string remove header or control characters from a string create a string that uses variables extract information from a bar code

Use this instruction

CONCAT

DELETE

FIND

INSERT

MID


relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text relay ladder structured text

See page

601

603

605

607

609

You can also use the following instructions to compare or convert ASCII characters:

If you want to

compare a string to another string see if the characters are equal to specific characters see if the characters are not equal to specific characters see if the characters are equal to or greater than specific characters see if the characters are greater than specific characters see if the characters are equal to or less than specific characters see if the characters are less than specific characters rearrange the bytes of a INT, DINT, or REAL tag find a string in an array of strings convert characters to a SINT, INT, DINT, or REAL value

Use this instruction See page

CMP

EQU

206

211

NEQ

GEQ

GRT

242

211

219

LEQ

LES

SWPB

FSC

STOD

223

227

299

346

614



599

Chapter 18 ASCII String Instructions (CONCAT, DELETE, FIND, INSERT, MID)

If you want to

convert characters to a REAL value convert a SINT, INT, DINT, or REAL value to a string of ASCII characters convert REAL value to a string of ASCII characters

Use this instruction See page

STOR

DTOS

RTOS

616

619

621



•


•



Name

LEN

Data Type

DINT


Description


Notes




DATA SINT array ASCII characters of the string


•



•


•


600



ASCII String Instructions (CONCAT, DELETE, FIND, INSERT, MID) Chapter 18

String Concatenate

(CONCAT)

Operands:

The CONCAT instruction adds ASCII characters to the end of a string.

Relay Ladder

Operand

Source A

CONCAT

String Concatenate

Source A

Source B

Dest

?

??

?

??

?

??

Type

string

Source B

Destination string string

Format

tag tag tag

Enter

tag that contains the initial characters tag that contains the end characters tag to store the result

Notes


•

• default STRING data type any new string data type that you create

Structured Text

CONCAT(SourceA,SourceB,

Dest);

The operands are the same as those for the relay ladder CONCAT instruction.

Description:

The CONCAT instruction combines the characters in Source A with the characters in Source B and places the result in the Destination.

•

The characters from Source A are first, followed by the characters from

Source B.

•

Unless Source A and the Destination are the same tag, Source A remains unchanged.


not affected


Type

4

Code

51

Cause

The LEN value of the string tag is greater than the DATA size of the string tag.

Recovery Method

1. Check that no instruction is writing to the LEN member of the string tag.

2. In the LEN value, enter the number of characters that the string contains.



601


Execution:

Condition


EnableIn is set








No action taken.

na na



The instruction concatenates the strings.


No action taken.

Example:

To trigger a message in a MessageView terminal, the controller must send an

ASCII string that contains a message number and node number. String_1 contains the message number. When add_node is set, the CONCAT instruction adds the characters in node_num_ascii (node number) to the end of the characters in string_1 and then stores the result in msg.

Relay Ladder

add_node CONCAT

String Concatenate

Source A string_1

'$1423\'

Source B node_num_ascii

'1'

Dest msg

'$1423\1'

Structured Text

IF add_node THEN

CONCAT(string_1,node_num_ascii,msg); add_node := 0;

END_IF;

602




String Delete (DELETE)

Operands:

The DELETE instruction removes ASCII characters from a string.

Relay Ladder

DELETE

String Delete

Source ?

Qty

Start

??

?

??

?

Dest

??

?

??

Operand

Source

Type

string

Format

tag immediate tag immediate tag

Enter

tag that contains the string from which you want to delete characters number of characters to delete

Notes




The Start plus the Quantity must be less than or equal to the DATA size of the Source.

Quantity

Start

SINT

INT

DINT

SINT

INT

DINT

string position of the first character to delete

Enter a number between 1 and the DATA size of the Source.

Destination tag tag to store the result

Structured Text

DELETE(Source,Qty,Start,

Dest);

The operands are the same as those for the relay ladder DELETE instruction.

Description:

The DELETE instruction deletes (removes) a group of characters from the

Source and places the remaining characters in the Destination.

•

The Start position and Quantity define the characters to remove.

•

Unless the Source and Destination are the same tag, the Source remains unchanged.



603


Type

4

4


not affected

Code

51

56


Cause


Recovery Method



The Start or Quantity value is invalid. 1. Check that the Start value is between 1 and the DATA size of the

Source.

2. Check that the Start value plus the Quantity value is less than or equal to the DATA size of the Source.

Condition


EnableIn is set

Execution:






na


No action taken na na



instruction execution postscan

The instruction deletes the specified characters.


No action taken.

term_read.EM

Example:

ASCII information from a terminal contains a header character. After the controller reads the data (term_read.EM is set) the DELETE instruction removes the header character.

Relay Ladder

DELETE

String Delete

Source term_input

'$0655'

1 Qty

Start 1

Dest term_text

'55'

Structured Text

IF term_read.EM THEN

DELETE(term_input,1,1,term_text); term_read.EM := 0;

END_IF;

604




Find String (FIND)

Operands:

The FIND instruction locates the starting position of a specified string within another string

Relay Ladder

FIND

Find String

Source

Search

Start

Result

?

??

?

??

?

??

?

??

Operand

Source

Search

Type

string string

Format

tag tag

Enter

string to search in string to find position in Source to start the search

Notes





Start

Result

SINT

INT

DINT

SINT

INT

DINT

immediate tag tag tag that stores the starting position of the string to find

Structured Text

FIND(Source,Search,Start,

Result);

The operands are the same as those for the relay ladder FIND instruction described above.

Description:

The FIND instruction searches the Source string for the Search string. If the instruction finds the Search string, the Result shows the starting position of the Search string within the Source string.


not affected

Type

4

4

Code

51


Cause


56 The Start value is invalid.

Recovery Method



Check that the Start value is between 1 and the DATA size of the Source.



605


Condition



Execution:






No action taken.

na na




The instruction searches for the specified characters.


No action taken.

MV_read.EM

Example:

A message from a MessageView terminal contains several pieces of information. The backslash character [ \ ] separates each piece of information.

To locate a piece of information, the FIND instruction searches for the backslash character and records its position in find_pos.

Relay Ladder

FIND

Find String

Source MV_msg

'$06324\12\1\$r'

Search find

Start

'\'

1

Result find_pos

5

Structured Text

IF MV_read.EM THEN

FIND(MV_msg,find,1,find_pos);

MV_read.EM := 0;

END_IF;

606




Insert String (INSERT)

The INSERT instruction adds ASCII characters to a specified location within a string.

Operands:

Relay Ladder

INSERT

Insert String

Source A

Source B

?

??

?

Start

Dest

??

?

??

?

??

Operand

Source A

Source B

Start

Type

string string

SINT

INT

DINT

string

Format

tag tag immediate tag

Enter

string to add the characters to string containing the characters to add position in Source A to add the characters

Notes


•

• default STRING data type any new string data type that you create


Result tag string to store the result

Structured Text

INSERT(SourceA,SourceB,

Start,Dest);

The operands are the same as those for the relay ladder INSERT instruction.

Description:

The INSERT instruction adds the characters in Source B to a designated position within Source A and places the result in the Destination:

•

Start defines where in Source A that Source B is added.

•

Unless SourceA and the Destination are the same tag, Source A remains unchanged.


not affected


Type

4

4

Code

51

56

Cause


The Start value is invalid.

Recovery Method



Check that the Start value is between 1 and the DATA size of the Source.



607


Execution:

Condition


EnableIn is set








No action taken.

na na



The instruction inserts the specified characters.


No action taken.

Example:

When temp_high is set, the INSERT instruction adds the characters in string_2 to position 2 within string_1 and places the result in string_3:

Relay Ladder

temp_high INSERT

Insert String

Source A stri

'AD'

Source B stri

'BC'

Start

Dest s

'ABCD'

Structured Text

IF temp_high THEN

INSERT(string_1,string_2,2,string_3); temp_high := 0;

END_IF;

608




Middle String (MID)

The MID instruction copies a specified number of ASCII characters from a string and stores them in another string.

Operands:

Relay Ladder

MID

Middle String

Source

Qty

?

??

?

Start

Dest

??

?

??

?

??

Operand

Source

Type

string

Format

tag

Enter

string to copy characters from number of characters to copy

Notes




The Start plus the Quantity must be less than or equal to the DATA size of the Source.

Quantity

Start

SINT

INT

DINT

SINT

INT

DINT

string immediate tag immediate tag position of the first character to copy


Destination tag string to copy the characters to

Structured Text

MID(Source,Qty,Start,

Dest);

The operands are the same as those for the relay ladder MID instruction.

Description:

The MID instruction copies a group of characters from the Source and places the result in the Destination.

•

The Start position and Quantity define the characters to copy.

•

Unless the Source and Destination are the same tag, the Source remains unchanged.


not affected



609


Type

4

4

Code

51

56


Cause


Recovery Method



The Start or Quantity value is invalid. 1. Check that the Start value is between 1 and the DATA size of the

Source.

2. Check that the Start value plus the Quantity value is less than or equal to the DATA size of the Source.

Condition


EnableIn is set instruction execution postscan bag_read.EM

Execution:






No action taken.

na na




The instruction copies the specified characters from a string and stores them in another string.


No action taken.

Example:

In a baggage handling conveyor of an airport, each bag gets a bar code.

Characters 9 - 17 of the bar code are the flight number and destination airport of the bag. After the bar code is read (bag_read.EM is set) the MID instruction copies the flight number and destination airport to the bag_flt_and_dest string.

Relay Ladder

MID

Middle String

Source bag_barcode

'NWA HOP 5058 AMS 01'

Qty 9

Start

Dest bag_flt_and_dest

'5058 AMS '

Structured Text

IF bag_read.EM THEN

MID(bar_barcode,9,9,bag_flt_and_dest); bag_read.EM := 0;

END_IF;

610



Chapter

19

ASCII Conversion Instructions

(STOD, STOR, DTOS, RTOS, UPPER, LOWER)

Introduction

Use the ASCII conversion instructions to alter the format of data.

If You Want To For Example

convert the ASCII representation of an integer value to a SINT, INT, DINT, or REAL value convert the ASCII representation of a floating-point value to a REAL value convert a value from a weight scale or other ASCII device to an integer so you can use it in your logic convert a value from a weight scale or other ASCII device to a REAL value so you can use it in your logic

Use This

Instruction

STOD

STOR convert a SINT, INT, DINT, or REAL value to a string of ASCII characters convert a REAL value to a string of

ASCII characters convert the letters in a string of ASCII characters to upper case convert the letters in a string of ASCII characters to lower case convert a variable to an ASCII string so you can send it to a MessageView terminal convert a variable to an ASCII string so you can send it to a MessageView terminal convert an entry made by an operator to all upper case so you can search for it in an array convert an entry made by an operator to all lower case so you can search for it in an array

DTOS

RTOS

UPPER

LOWER

Available In These

Languages

relay ladder

See Page

614 structured text relay ladder structured text relay ladder structured text relay ladder

616

619

621 structured text relay ladder structured text relay ladder structured text

623

625



611

Chapter 19 ASCII Conversion Instructions (STOD, STOR, DTOS, RTOS, UPPER, LOWER)

You can also use the following instructions to compare or manipulate ASCII characters:

If You Want To

add characters to the end of a string delete characters from a string determine the starting character of a sub-string insert characters into a string extract characters from a string rearrange the bytes of a INT, DINT, or REAL tag compare a string to another string see if the characters are equal to specific characters see if the characters are not equal to specific characters see if the characters are equal to or greater than specific characters see if the characters are greater than specific characters see if the characters are equal to or less than specific characters see if the characters are less than specific characters find a string in an array of strings

Use This Instruction See Page

CONCAT

DELETE

601

603

FIND

INSERT

MID

SWPB

605

607

609

299

GRT

LEQ

LES

FSC

CMP

EQU

NEQ

GEQ

219

223

227

346

206

211

242

215

612



ASCII Conversion Instructions (STOD, STOR, DTOS, RTOS, UPPER, LOWER) Chapter 19



•


•



Name:

LEN

Data Type:

DINT


Description:


Notes:




DATA SINT array ASCII characters of the string


•



•


•




613


String To DINT (STOD)

The STOD instruction converts the ASCII representation of an integer to an integer or REAL value.

Operands:

Relay Ladder

Operand

Source

STOD

String To DINT

Source ?

Dest

??

?

??

Type

string

Destination SINT

INT

DINT

REAL

Format

tag tag

Enter

tag that contains the value in ASCII tag to store the integer value

Notes




If the Source value is a floating-point number, the instruction converts only the non-fractional part of the number (regardless of the destination data type).

STOD(Source,Dest);

Structured Text

The operands are the same as those for the relay ladder STOD instruction.

Description:

The STOD converts the Source to an integer and places the result in the

Destination.

•

The instruction converts positive and negative numbers.

•

If the Source string contains non-numeric characters, the STOD converts the first set of contiguous numbers:

–

The instruction skips any initial control or non-numeric characters

(except the minus sign in front of a number).

–

If the string contains multiple groups of numbers that are separated by delimiters (for example, / ), the instruction converts only the first group of numbers.



614




Type

4

4

Code

51

53

Fault Conditions

Cause


Recovery Method


The output number is beyond the limits of the destination data type.


Either:

•

Reduce the size of the ASCII value.

•

Use a larger data type for the destination.

Condition


EnableIn is set

Execution:








No action taken.

na na



SC is set.

Destination is cleared.

The instruction converts the Source.

If the result is zero, then S:Z is set


No action taken.

Example:

When MV_read.EM is set, the STOD instruction converts the first set of numeric characters in MV_msg to an integer value. The instruction skips the initial control character ($06) and stops at the delimiter ( \ ).

Relay Ladder

MV_read.EM

STOD

String To DINT

Source MV_msg

'$06324\12\1\$r'

Dest MV_msg_nmbr

324

Structured Text

IF MV_read.EM THEN



615


STOD(MV_msg,MV_msg_nmbr);

MV_read.EM := 0;

END_IF;

String To REAL (STOR)

Operands:

The STOR instruction converts the ASCII representation of a floating-point value to a REAL value.


STOR

String to Real

Source ?

??

Dest ?

??

Operand

Source

Destination

Type

string

REAL

Format

tag tag

Enter

tag that contains the value in ASCII

Notes



• any new string data type that you create tag to store the REAL value

STOR(Source,Dest);

Structured Text

The operands are the same as those for the relay ladder STOR instruction.

Description:

The STOR converts the Source to a REAL value and places the result in the

Destination.

•

The instruction converts positive and negative numbers.

•

If the Source string contains non-numeric characters, the STOR converts the first set of contiguous numbers, including the decimal point [ . ]:

–

The instruction skips any initial control or non-numeric characters

(except the minus sign in front of a number).

–

If the string contains multiple groups of numbers that are separated by delimiters (for example, / ), the instruction converts only the first group of numbers.



616




Type

4

4

Code

51

53


Cause


Recovery Method


The output number is beyond the limits of the destination data type.


Either:

•

Reduce the size of the ASCII value.

•

Use a larger data type for the destination.

Condition


EnableIn is ste

Execution:








No action taken.

na na



S:C is set.

Destination is cleared.


If the result is zero, then S:Z is set


No action taken.

Example:

After reading the weight from a scale (weight_read.EM is set) the STOR instruction converts the numeric characters in weight_ascii to a REAL value.

You may see a slight difference between the fractional parts of the Source and

Destination.

Relay Ladder

weight_read.EM

STOR

String to Real

Source weight_ascii

'428.259'

Dest weight

428.259



617


Structured Text

IF weight_read.EM THEN

STOR(weight_ascii,weight); weight_read.EM := 0;

END_IF;

618




DINT to String (DTOS)

Operands:

The DTOS instruction produces the ASCII representation of a value.

Relay Ladder

DTOS

DINT to String

Source ?

??

Dest ?

??

Operand

Source

Type

SINT

INT

DINT

REAL string

Format

tag

Enter Notes

tag that contains the value If the Source is a REAL, the instruction converts it to a DINT value. Refer to REAL to an Integer on page 640 .

Destination tag tag to store the ASCII value String data types are:



DTOS(Source,Dest);

Structured Text

The operands are the same as those for the relay ladder DTOS instruction.

Description:

The DTOS converts the Source to a string of ASCII characters and places the result in the Destination.


not affected


Type

4

4

Code

51

52

Cause


Recovery Method


The output string is larger than the destination.


Create a new string data type that is large enough for the output string. Use the new string data type as the data type for the destination.



619


Execution:

Condition


EnableIn is set








No action taken.

na na





No action taken.

Example:

When temp_high is set, the DTOS instruction converts the value in msg_num to a string of ASCII characters and places the result in msg_num_ascii. Subsequent rungs insert or concatenate msg_num_ascii with other strings to produce a complete message for a display terminal.

Relay Ladder

temp_high

Structured Text

IF temp_high THEN

DTOS(msg_num,msg_num_ascii); temp_high := 0;

END_IF;

DTOS

DINT to String

Source msg_num

23

Dest msg_num_ascii

'23'

620




REAL to String (RTOS)

Operands:

The RTOS instruction produces the ASCII representation of a REAL value.

Relay Ladder

RTOS

Real to String

Source ?

Dest

??

?

??

Operand

Source

Destination

Type

REAL string

Format

tag tag

Enter

tag that contains the REAL value

Notes

tag to store the ASCII value String data types are:



RTOS(Source,Dest);

Structured Text

The operands are the same as those for the relay ladder RTOS instruction.

Description:

The RTOS converts the Source to a string of ASCII characters and places the result in the Destination.


not affected


Type

4

4

Code

51

52

Cause


Recovery Method


The output string is larger than the destination.


Create a new string data type that is large enough for the output string. Use the new string data type as the data type for the destination.



621


Execution:

Condition


EnableIn is set








No action taken.

na na





No action taken.

Example:

When send_data is set, the RTOS instruction converts the value in data_1 to a string of ASCII characters and places the result in data_1_ascii. Subsequent rungs insert or concatenate data_1_ascii with other strings to produce a complete message for a display terminal.

You may see a slight difference between the fractional parts of the Source and

Destination.

Relay Ladder

send_data RTOS

Real to String

Source data_1

15.3001

Dest data_1_ascii

'15.3001003'

Structured Text

IF send_data THEN

RTOS(data_1,data_1_ascii); send_data := 0;

END_IF;

622




Upper Case (UPPER)

Operands:

The UPPER instruction converts the alphabetical characters in a string to upper case characters.

Relay Ladder

Operand

Source

Type

string

Destination string

Format

tag tag

Description

tag that contains the characters that you want to convert to upper case tag to store the characters in upper case

UPPER(Source,Dest);

Structured Text

The operands are the same as those for the relay ladder UPPER instruction.

Description:

The UPPER instruction converts to upper case all the letters in the Source and places the result in the Destination.

•


•

If operators directly enter ASCII characters, convert the characters to all upper case or all lower case before you compare them.

Any characters in the Source string that are not letters remain unchanged.


not affected


none

Execution:

Condition








na


No action taken.

na na



The instruction converts the Source to upper case.


No action taken.



623


Example:

To find information about a specific item, an operator enters the catalog number of the item into an ASCII terminal. After the controller reads the input from a terminal (terminal_read.EM is set), the UPPER instruction converts the characters in catalog_number to all upper case characters and stores the result in catalog_number_upper_case. A subsequent rung then searches an array for characters that match those in catalog_number_upper_case.

Relay Ladder

Structured Text

IF terminal_read.EM THEN

UPPER(catalog_number,catalog_number_upper_case); terminal_read.EM := 0;

END_IF;

624




Lower Case (LOWER)

Operands:

The LOWER instruction converts the alphabetical characters in a string to lower case characters.

Relay Ladder

Operand

Source

Type

string

Destination string

Format

tag tag

Description

tag that contains the characters that you want to convert to lower case tag to store the characters in lower case

LOWER(Source,Dest);

Structured Text

The operands are the same as those for the relay ladder LOWER instruction.

Description:

The LOWER instruction converts to lower case all the letters in the Source and places the result in the Destination.

•


•

If operators directly enter ASCII characters, convert the characters to all upper case or all lower case before you compare them.

Any characters in the Source string that are not letters remain unchanged.


not affected


none

Execution:

Condition








na


No action taken.

na na



The instruction converts the Source to lower case.


No action taken.



625


Example:

To find information about a specific item, an operator enters the item number into an ASCII terminal. After the controller reads the input from a terminal

(terminal_read.EM is set), the LOWER instruction converts the characters in

item_number to all lower case characters and stores the result in

item_number_lower_case. A subsequent rung then searches an array for characters that match those in item_number_lower_case.

Relay Ladder

Structured Text

IF terminal_read.EM THEN

LOWER(item_number,item_number_lower_case); terminal_read.EM := 0;

END_IF;

626



Chapter

20

Debug Instructions

(BPT, TPT)

Introduction

If You Want To

stop program emulation when a rung is true log data you select when a rung is true

Use the debug instructions to monitor the state of your logic when it is in conditions that you determine. These instructions are only compatible with

RSLogix Emulate 5000 software, with which you can emulate a Logix 5000 controller on your personal computer.


BPT

TPT


relay ladder relay ladder

See Page

627

631

Breakpoints (BPT)

Operands:

Breakpoints stop program emulation when a rung is true.

Relay Ladder

Operand

Format

Type

String

Trace This BOOL, SINT, INT,

DINT, REAL


tag

A string that sets the formatting for the text that appears in the trace window for the breakpoint.

tag

The tag that has a value you want to display in the trace window.

Description:

Breakpoints are programmed with the Breakpoint output instruction (BPT).

When the inputs on a rung containing a BPT instruction are true, the BPT instruction stops program execution. The software displays a window indicating that the breakpoint triggered and the values that triggered it.



627

Chapter 20 Debug Instructions (BPT, TPT)

When a breakpoint triggers, the emulator displays a window informing you that a breakpoint occurred. The title bar of the window shows the slot containing the emulator that encountered the breakpoint.

When you click OK, the emulator resumes program execution. If the conditions that triggered the breakpoint persist, the breakpoint will recur.

In addition, the emulator opens a trace window for the breakpoint. The trace window displays information about the breakpoint and the values.

ATTENTION

When a breakpoint triggers, you will not be able to edit your project until you permit the execution to continue. You can go online with the emulator to observe the state of your project, but you will not be able to edit it. If you try to accept a rung edit while a breakpoint is triggered, you will see a dialog box saying the controller is not in the correct mode.

String Format

With the Format string in the tracepoint and breakpoint instructions, you can control how the traced tags appear in the traces or breakpoint windows. The format of the string is as shown here: heading:(text)%(type) where heading is a text string identifying the tracepoint or breakpoint, text is a string describing the tag (or any other text you choose), and %(type) indicates the format of the tag. You need one type indicator for each tag you are tracing with the tracepoint or breakpoint instruction.

For example, you could format a tracepoint string as shown here:

My tracepoint:Tag 1 = %e and Tag 2 = %d

The %e formats the first traced tag as double-precision float with an exponent, and %d formats the second traced tag as a signed decimal integer.

In this case, you would have a tracepoint instruction that has two Trace This operands (one for a REAL and one for an INT, although the value of any tag can be formatted with any flag).

628



Debug Instructions (BPT, TPT) Chapter 20

The resulting tracepoint window that would appear when the tracepoint is triggered would look like this.

The heading (the text preceding the colon in the format string) appears here.

The slot number indicates the slot containing the emulator module that has the tracepoint or breakpoint being traced in the trace window.

The text for the REAL (represented in the format string as %e) appears here.

The text for the INT

(represented in the format string as %d) appears here.

postscan


not affected


none

Execution:

Condition:








Example:

You can display many tag values with the BPT instruction. However, the formatting string can contain only 82 characters. Because the formatting string requires two characters for each tag you want in the breakpoint, you cannot trace more than 41 tags with a single BPT instruction. However, to separate tag data in your traces, you will need to include spaces and other formatting, thus reducing the number of tag values that one BPT instruction can effectively display to far fewer than 41.



629


This rung shows a breakpoint that stops program execution when an analog value is greater than 3.02 or less than 2.01.

You want to display the breakpoint information in the Format string

(myformat). In this case, the format string contains the following text:

Breakpoint:The input value is %f

When the breakpoint triggers, the breakpoint trace window shows the characters before the colon (“Breakpoint”) in the title bar of the trace window.

The other characters make up the traces. In this example, %f represents the first (and in this case, the only) tag to be traced (“analogvalue”).

The resulting traces appear as shown here.

630




Tracepoints (TPT)

Trace points log data you select when a rung is true.

Operands:

Relay Ladder

Operand

Format

Type

String

Format

tag

Description

A string that sets the formatting for the trace reports (both on-screen and logged to disk).

The tag you want to trace.

Trace This BOOL, SINT,

INT, DINT,

REAL tag

Description:

Tracepoints are programmed with the tracepoint output instruction (TPT).

When the inputs on a rung containing a TPT instruction are true, the TPT instruction writes a trace entry to a trace display or log file.

You can trace many tags with the TPT instruction. However, the formatting string can contain only 82 characters. Because the formatting string requires two characters for each tag you want to trace, you cannot trace more than 41 tags with a single TPT instruction. However, to separate tag data in your traces, you will need to include spaces and other formatting, thus reducing the number of tags that one TPT instruction can effectively trace to far fewer than

41.

String Format

With the Format string in the tracepoint and breakpoint instructions, you can control how the traced tags appear in the traces or breakpoint windows. The format of the string is as shown here: heading:(text)%(type) where heading is a text string identifying the tracepoint or breakpoint, text is a string describing the tag (or any other text you choose), and %(type) indicates the format of the tag. You need one type indicator for each tag you are tracing with the tracepoint or breakpoint instruction.

For example, you could format a tracepoint string as shown here:

My tracepoint:Tag 1 = %e and Tag 2 = %d



631


The %e formats the first traced tag as double-precision float with an exponent, and %d formats the second traced tag as a signed decimal integer.

In this case, you would have a tracepoint instruction that has two Trace This operands (one for a REAL and one for an INT, although the value of any tag can be formatted with any flag).

The resulting tracepoint window that would appear when the tracepoint is triggered would look like this.

The heading (the text preceding the colon in the format string) appears here.

The slot number indicates the slot containing the emulator module that has the tracepoint or breakpoint being traced in the trace window.

The text for the REAL (represented in the format string as %e) appears here.

The text for the INT

(represented in the format string as %d) appears here.

postscan

.


not affected


none

Execution:

Condition:








632




Example:

This rung triggers a trace of three analog values when any one of them exceeds a given value (30.01).

You want to display the tracepoint information in the Format string

(myformat). In this case, the format string contains this text:

Analog inputs trace:Analog inputs = %f, %f, and %f

When the tracepoint triggers, the characters before the colon (“Analog inputs trace”) appear in the title bar of the trace window. The other characters make up the traces. In this example, %f represents the tags to be traced

(“analogvalue1,” “analogvalue2,” and “analogvalue3”).

The resulting traces appear as shown here.

When this trace is logged to disk, the characters before the colon appear in the traces.



633


This indicates which tracepoint caused which trace entry. This is an example of a trace entry. “Analog inputs trace:” is the heading text from the tracepoint's format string.

Analog inputs trace:Analog inputs = 31.00201, 30.282000, and 30.110001

634



Introduction

Immediate Values

Data Conversions

Appendix

A

Common Attributes

This appendix describes attributes that are common to the Logix instructions.

For Information About

Immediate Values

Data Conversions

See Page

635

635

Whenever you enter an immediate value (constant) in decimal format (for example, -2, 3) the controller stores the value using 32 bits. If you enter a value in a radix other than decimal, such as binary or hexadecimal, and do not specify all 32 bits, the controller places a zero in the bits that you do not specify (zero-fill).

EXAMPLE

Zero-filling of immediate values

If You Enter

-1

16#ffff (-1)

8#1234 (668)

2#1010 (10)

The Controller Stores

16#ffff ffff (-1)

16#0000 ffff (65535)

16#0000 029c (668)

16#0000 000a (10)

Data conversions occur when you mix data types in your programming:

When Programming in Conversions Can Occur When You

Relay Ladder Logic Mix data types for the parameters within one instruction

Function Block Wire two parameters that have different data types

Publication 1756-RM003K-EN-P - July Year


635

Appendix A Common Attributes

Instructions execute faster and require less memory if all the operands of the instruction use:

• the same data type

• an optimal data type:

–

In the “Operands” section of each instruction in this manual, a bold data type indicates an optimal data type.

–

The DINT and REAL data types are typically the optimal data types.

–

Most function block instruction only support one data type (the optimal data type) for its operands.

If you mix data types and use tags that are not the optimal data type, the controller converts the data according to these rules

•

Are any of the operands a REAL value?

If

Yes

No

Then input operands (for example., source, tag in an expression, limit) convert to

REALs

DINTs

•

After instruction execution, the result (a DINT or REAL value) converts to the destination data type, if necessary.

You cannot specify a BOOL tag in an instruction that operates on integer or

REAL data types.

Because the conversion of data takes additional time and memory, you can increase the efficiency of your programs by:

• using the same data type throughout the instruction

• minimizing the use of the SINT or INT data types

In other words, use all DINT tags or all REAL tags, along with immediate values, in your instructions.

The following sections explain how the data is converted when you use SINT or INT tags or when you mix data types.

636



Common Attributes Appendix A

SINT or INT to DINT

For those instructions that convert SINT or INT values to DINT values, the

“Operands” sections in this manual identify the conversion method.

This Conversion Method

Sign-extension

Zero-fill

Converts Data By Placing

the value of the left-most bit (the sign of the value) into each bit position to the left of the existing bits until there are 32 bits.

zeroes to the left of the existing bits until there are 32 bits

The following example shows the results of converting a value using sign-extension and zero-fill.

This value

Converts to this value by sign-extension

Converts to this value by zero-fill

2#1111_1111_1111_1111

2#1111_1111_1111_1111_1111_1111_1111_1111

2#0000_0000_0000_0000_1111_1111_1111_1111

(-1)

(-1)

(65535)

Because immediate values are always zero-filled, the conversion of a SINT or

INT value may produce unexpected results. In the following example, the comparison is false because Source A, an INT, converts by sign-extension; while Source B, an immediate value, is zero-filled.

dder Logic Listing - Total number of rungs: 3

EQU

Equal

Source A remote_rack_1:I.Data[0]

2#1111_1111_1111_1111

Source B 2#1111_1111_1111_1111

42093



637


If you use a SINT or INT tag and an immediate value in an instruction that converts data by sign-extension, use one of these methods to handle immediate values:

•

Specify any immediate value in the decimal radix

•

If you are entering the value in a radix other than decimal, specify all 32 bits of the immediate value. To do so, enter the value of the left-most bit into each bit position to its left until there are 32 bits.

•

Create a tag for each operand and use the same data type throughout the instruction. To assign a constant value, either:

–

Enter it into one of the tags

–

Add a MOV instruction that moves the value into one of the tags.

•

Use a MEQ instruction to check only the required bits

The following examples show two ways to mix an immediate value with an

INT tag. Both examples check the bits of a 1771 I/O module to determine if all the bits are on. Since the input data word of a 1771 I/O module is an INT tag, it is easiest to use a 16-bit constant value.

EXAMPLE

Mixing an INT tag with an immediate value

Since remote_rack_1:I.Data[0] is an INT tag, the value to check it against is also entered as an INT tag.

EQU

Equal


Source B

2#1111_1111_1111_1111 int_0

2#1111_1111_1111_1111

42093

EXAMPLE

Mixing an INT tag with an immediate value

Since remote_rack_1:I.Data[0] is an INT tag, the value to check it against first moves into int_0, also an INT tag. The

EQU instruction then compares both tags.

2#1111_1111_1111_1111

MOV

Move

Source 2#1111_1111_1111_1111

Dest int_0

2#1111_1111_1111_1111

EQU

Equal


2#1111_1111_1111_1111

Source B int_0

2#1111_1111_1111_1111

42093

638



Common Attributes Appendix A

Integer to REAL

The controller stores REAL values in IEEE single-precision, floating-point number format. It uses one bit for the sign of the value, 23 bits for the base value, and eight bits for the exponent (32 bits total). If you mix an integer tag

(SINT, INT, or DINT) and a REAL tag as inputs in the same instruction, the controller converts the integer value to a REAL value before the instruction executes.

•

A SINT or INT value always converts to the same REAL value.

•

A DINT value may not convert to the same REAL value:

–

A REAL value uses up to 24 bits for the base value (23 stored bits plus a “hidden” bit).

–

A DINT value uses up to 32 bits for the value (one for the sign and

31 for the value).

–

If the DINT value requires more than 24 significant bits, it may not convert to the same REAL value. If it will not, the controller rounds to the nearest REAL value using 24 significant bits.

DINT to SINT or INT

To convert a DINT value to a SINT or INT value, the controller truncates the upper portion of the DINT and sets the overflow status flag, if necessary. The following example shows the result of a DINT to SINT or INT conversion.

EXAMPLE

Conversion of a DINT to an INT and a SINT

This DINT Value

16#0001_0081 (65,665)

Converts To This Smaller Value

INT: 16#0081 (129)



639


REAL to an Integer

To convert a REAL value to an integer value, the controller rounds the fractional part and truncates the upper portion of the non-fractional part. If data is lost, the controller sets the overflow status flag. Numbers round as follows:

•

Numbers other than x.5 round to the nearest whole number.

•

X.5 rounds to the nearest even number.

The following example show the result of converting REAL values to DINT values.

EXAMPLE

Conversion of REAL values to DINT values

-1.4

1.4

1.5

1.6

2.5

This REAL Value

-2.5

-1.6

-1.5

2

2

-1

1

2

-2

-2

Converts To This DINT Value

-2

IMPORTANT

The arithmetic status flags are set based on the value being stored. Instructions that normally do not affect arithmetic status keywords might appear to do so if type conversion occurs because of mixed data types for the instruction parameters. The type conversion process sets the arithmetic status keywords.

640



Appendix

B

Function Block Attributes

Introduction

This appendix describes issues that are unique with function block instructions. Review the information in this appendix to make sure you understand how your function block routines will operate.

IMPORTANT

When programming in function block, restrict the range of engineering units to

+/-10

+/-15

because internal floating point calculations are done using single precision floating point. Engineering units outside of this range may result in a loss of accuracy if results approach the limitations of single precision floating point (+/-10

+/-38

).

Choose the Function Block

Elements

input reference (IREF)

To control a device, use the following elements: function block output reference (OREF) input wire connector

(ICON)

Use the following table to choose your function block elements:z

If You Want To

supply a value from an input device or tag send a value to an output device or tag

Use a

input reference (IREF) output reference (OREF) output wire connector

(OCON)



641

Appendix B Function Block Attributes

If You Want To

perform an operation on an input value or values and produce an output value or values transfer data between function blocks when they are:

Use a

function block output wire connector (OCON) and an input wire connector (ICON)

• far apart on the same sheet

• on different sheets within the same routine disperse data to several points in the routine single output wire connector (OCON) and multiple input wire connectors (ICON)

Latching Data

If you use an IREF to specify input data for a function block instruction, the data in that IREF is latched for the scan of the function block routine. The

IREF latches data from program-scoped and controller-scoped tags. The controller updates all IREF data at the beginning of each scan.

IREF

In this example, the value of tagA is stored at the beginning of the routine’s execution. The stored value is used when Block_01 executes. The same stored value is also used when Blcock_02 executes. If the value of tagA changes during execution of the routine, the stored value of tagA in the IREF does not change until the next execution of the routine.

Block_01 tagA

Block_02

642



Function Block Attributes Appendix B

This example is the same as the one above. The value of tagA is stored only once at the beginning of the routine’s execution. The routine uses this stored value throughout the routine.

Block_01 tagA

Block_02 tagA

Starting with RSLogix 5000 software, version 11, you can use the same tag in multiple IREFs and an OREF in the same routine. Because the values of tags in IREFs are latched every scan through the routine, all IREFs will use the same value, even if an OREF obtains a different tag value during execution of the routine. In this example, if tagA has a value of 25.4 when the routine starts executing this scan, and Block_01 changes the value of tagA to 50.9, the second IREF wired into Block_02 will still use a value of 25.4 when Block_02 executes this scan. The new tagA value of 50.9 will not be used by any IREFs in this routine until the start of the next scan.



643


Order of Execution

The RSLogix 5000 programming software automatically determines the order of execution for the function blocks in a routine when you:

• verify a function block routine

• verify a project that contains a function block routine

• download a project that contains a function block routine

You define execution order by wiring function blocks together and indicating the data flow of any feedback wires, if necessary.

If function blocks are not wired together, it does not matter which block executes first. There is no data flow between the blocks.

If you wire the blocks sequentially, the execution order moves from input to output. The inputs of a block require data to be available before the controller can execute that block. For example, block 2 has to execute before block 3 because the outputs of block 2 feed the inputs of block 3.

1 2 3

Execution order is only relative to the blocks that are wired together. The following example is fine because the two groups of blocks are not wired together. The blocks within a specific group execute in the appropriate order in relation to the blocks in that group.

1 3 5

2 4 6

644




Resolve a Loop

To create a feedback loop around a block, wire an output pin of the block to an input pin of the same block. The following example is OK. The loop contains only a single block, so execution order does not matter.

This input pin uses an output that the block produced on the previous scan.

If a group of blocks are in a loop, the controller cannot determine which block to execute first. In other words, it cannot resolve the loop.

?

?

?

To identify which block to execute first, mark the input wire that creates the loop (the feedback wire) with the Assume Data Available indicator. In the following example, block 1 uses the output from block 3 that was produced in the previous execution of the routine.

1 2 3

This input pin uses the output that block 3 produced on the previous scan.

Assume Data Available indicator

The Assume Data Available indicator defines the data flow within the loop. The arrow indicates that the data serves as input to the first block in the loop.



645


1

This is OK

Do not mark all the wires of a loop with the Assume Data Available indicator.

This is NOT OK

2

?

?


The Assume Data Available indicator defines the data flow within the loop.

The controller cannot resolve the loop because all the wires use the

Assume Data Available indicator.

646




This is OK

Resolve Data Flow Between Two Blocks

If you use two or more wires to connect two blocks, use the same data flow indicators for all of the wires between the two blocks.

This is NOT OK

Neither wire uses the Assume Data Available indicator.

One wire uses the Assume Data Available indicator while the other wire does not.


Both wires use the Assume Data Available indicator.

Create a One Scan Delay

To produce a one scan delay between blocks, use the Assume Data Available indicator. In the following example, block 1 executes first. It uses the output from block 2 that was produced in the previous scan of the routine.

2 1




647


Summary

In summary, a function block routine executes in this order:

1.

The controller latches all data values in IREFs.

2.

The controller executes the other function blocks in the order determined by how they are wired.

3.

The controller writes outputs in OREFs.

Function Block Responses to Overflow Conditions

In general, the function block instructions that maintain history do not update history with ±NAN, or ±INF values when an overflow occurs. Each instruction has one of these responses to an overflow condition:

ALMNTCH

DEDTPMUL

DERVPOSP

ESELRLIM

FGENRMPS

HPFSCRV

LDL2SEL

LDLGSNEG

LPFSRTP

MAVESSUM

MAXCTOT

MINCUPDN

MSTD

MUX

Response 1:

Blocks execute their algorithm and check the result for

±

NAN or

±

INF. If

±

NAN or

±

INF, the block outputs

±

NAN or

±

INF.

Response 2: Response 3:

Blocks with output limiting execute their algorithm and check the result for

±

NAN or

±

INF. The output limits are defined by the

HighLimit and LowLimit input parameters.

If

±

INF, the block outputs a limited result.

If

±

NAN, the output limits are not used and the block outputs

±

NAN.

HLL

The overflow condition does not apply. These instructions typically have a boolean output.

BANDOSRI

INTG

PI

BNOTRESD

BORRTOR

PIDE

SCL

SOC

BXORSETD

CUTDTOFR

D2SDTONR

D3SD

DFF

JKFF

OSFI

648




Timing Modes

Timing Mode

periodic oversample

These process control and drives instructions support different timing modes.

DEDT

DERV

HPF

INTG

LDL2

LDLG

LPF

NTCH

PI

PIDE

RLIM

SCRV

SOC

TOT

There are three different timing modes:

Description

Periodic mode is the default mode and is suitable for most control applications. We recommend that you place the instructions that use this mode in a routine that executes in a periodic task. The delta time (DeltaT) for the instruction is determined as follows:

Then DeltaT Equals If The Instruction

Executes In a

periodic task period of the task event or continuous task elapsed time since the previous execution

The controller truncates the elapsed time to whole milliseconds (ms). For example, if the elapsed time = 10.5 ms, the controller sets DeltaT = 10 ms.

The update of the process input needs to be synchronized with the execution of the task or sampled 5-10 times faster than the task executes in order to minimize the sampling error between the input and the instruction.

In oversample mode, the delta time (DeltaT) used by the instruction is the value written into the OversampleDT parameter of the instruction. If the process input has a time stamp value, use the real time sampling mode instead.

Add logic to your program to control when the instruction executes. For example, you can use a timer set to the

OversampleDeltaT value to control the execution by using the EnableIn input of the instruction.

The process input needs to be sampled 5-10 times faster than the instruction is executed in order to minimize the sampling error between the input and the instruction.



649


Timing Mode

real time sampling

Description

In the real time sampling mode, the delta time (DeltaT) used by the instruction is the difference between two time stamp values that correspond to the updates of the process input. Use this mode when the process input has a time stamp associated with its updates and you need precise coordination.

The time stamp value is read from the tag name entered for the RTSTimeStamp parameter of the instruction.

Normally this tag name is a parameter on the input module associated with the process input.

The instruction compares the configured RTSTime value (expected update period) against the calculated

DeltaT to determine if every update of the process input is being read by the instruction. If DeltaT is not within

1 millisecond of the configuration time, the instruction sets the RTSMissed status bit to indicate that a problem exists reading updates for the input on the module.

Time-based instructions require a constant value for DeltaT in order for the control algorithm to properly calculate the process output. If DeltaT varies, a discontinuity occurs in the process output. The severity of the discontinuity depends on the instruction and range over which DeltaT varies. A discontinuity occurs if the:

• instruction is not executed during a scan.

• instruction is executed multiple times during a task.

• task is running and the task scan rate or the sample time of the process input changes.

• user changes the time base mode while the task is running.

•

Order parameter is changed on a filter block while the task is running.

Changing the Order parameter selects a different control algorithm within the instruction.

650




Input Parameter

TimingMode

Data Type

DINT

Common Instruction Parameters for Timing Modes

The instructions that support time base modes have these input and output parameters:

Input parameters

1

2

Description

Selects timing execution mode.

Value:

0

Description:

periodic mode oversample mode real time sampling mode

OversampleDT REAL valid = 0 to 2 default = 0

When TimingMode = 0 and task is periodic, periodic timing is enabled and DeltaT is set to the task scan rate. When TimingMode = 0 and task is event or continuous, periodic timing is enabled and DeltaT is set equal to the elapsed time span since the last time the instruction was executed.

When TimingMode = 1, oversample timing is enabled and DeltaT is set to the value of the

OversampleDT parameter.

When TimingMode = 2, real time sampling timing is enabled and DeltaT is the difference between the current and previous time stamp values read from the module associated with the input.

If TimingMode invalid, the instruction sets the appropriate bit in Status.

Execution time for oversample timing. The value used for DeltaT is in seconds. If

TimingMode = 1, then OversampleDT = 0.0 disables the execution of the control algorithm. If invalid, the instruction sets DeltaT = 0.0 and sets the appropriate bit in Status.

valid = 0 to 4194.303 seconds default = 0.0



651


Input Parameter

RTSTime

Data Type

DINT

RTSTimeStamp DINT


DeltaT

Data Type

REAL

Description

Module update period for real time sampling timing. The expected DeltaT update period is in milliseconds. The update period is normally the value that was used to configure the module’s update time. If invalid, the instruction sets the appropriate bit in Status and disables RTSMissed checking.

valid = 1 to 32,767ms default = 1

Module time stamp value for real time sampling timing. The time stamp value that corresponds to the last update of the input signal. This value is used to calculate DeltaT. If invalid, the instruction sets the appropriate bit in Status, disables execution of the control algorithm, and disables RTSMissed checking.

valid =1 to 32,767ms (wraps from 32767 to 0)

1 count = 1 millisecond default = 0

Output parameters

Description

Elapsed time between updates. This is the elapsed time in seconds used by the control algorithm to calculate the process output.

Status

TimingModeInv

(Status.27)

DINT

BOOL

RTSMissed (Status.28) BOOL

RTSTimeInv

(Status.29)

RTSTimeStampInv

(Status.30)

BOOL

BOOL

DeltaTInv (Status.31) BOOL

Periodic: DeltaT = task scan rate if task is Periodic task, DeltaT = elapsed time since previous instruction execution if task is Event or Continuous task

Oversample: DeltaT = OversampleDT

Real Time Sampling:

DeltaT = (RTSTimeStamp n

- RTSTimeStamp n-1

)


Invalid TimingMode value.

Only used in real time sampling mode. Set when ABS | DeltaT - RTSTime | > 1 (.001 second).

Invalid RTSTime value.

Invalid RTSTimeStamp value.

Invalid DeltaT value.

652




Overview of Timing Modes

The following diagram shows how an instruction determines the appropriate timing mode.

TimingMode = 0

Periodic timing

Determine task type

Determine time base mode

TimingMode = 1 TimingMode = 2

Oversample timing

DeltaT = OversampleDT

Real time timing

DeltaT = RTSTimeStamp n

- RTSTimeStamp n-1

If DeltaT < 0 or DeltaT > 4194.303 secs. the instruction sets DeltaT = 0.0 and sets the appropriate bit in Status.

If DeltaT > 0, the instruction executes.

Periodic task

DeltaT = task scan time

Event or Continuous task

DeltaT = elapsed time since last execution



653


Program/Operator Control

Several instructions support the concept of Program/Operator control. These instructions include:

•

Enhanced Select (ESEL)

•

Totalizer (TOT)

•

Enhanced PID (PIDE)

•

Ramp/Soak (RMPS)

•

Discrete 2-State Device (D2SD)

•

Discrete 3-State Device (D3SD)

Program/Operator control lets you control these instructions simultaneously from both your user program and from an operator interface device. When in

Program control, the instruction is controlled by the Program inputs to the instruction; when in Operator control, the instruction is controlled by the

Operator inputs to the instruction.

Program or Operator control is determined by using these inputs:

Input

.ProgProgReq

.ProgOperReq

.OperProgReq

.OperOperReq

Description

A program request to go to Program control.

A program request to go to Operator control.

An operator request to go to Program control.

An operator request to go to Operator control.

To determine whether an instruction is in Program or Control control, examine the ProgOper output. If ProgOper is set, the instruction is in

Program control; if ProgOper is cleared, the instruction is in Operator control.

Operator control takes precedence over Program control if both input request bits are set. For example, if ProgProgReq and ProgOperReq are both set, the instruction goes to Operator control.

654



Wiring a “1” into ProgOperReq means the user program always wants the

TOT to be in Operator control


The Program request inputs take precedence over the Operator request inputs.

This provides the capability to use the ProgProgReq and ProgOperReq inputs to “lock” an instruction in a desired control. For example, let’s assume that a

Totalizer instruction will always be used in Operator control, and your user program will never control the running or stopping of the Totalizer. In this case, you could wire a literal value of 1 into the ProgOperReq. This would prevent the operator from ever putting the Totalizer into Program control by setting the OperProgReq from an operator interface device.

Because the ProgOperReq input is always set, pressing the “Program” button on the faceplate (which sets the OperProgReg input) has no effect.

Normally, setting OperProgReq puts the TOT in Program control.



655


Likewise, constantly setting the ProgProgReq can “lock” the instruction into

Program control. This is useful for automatic startup sequences when you want the program to control the action of the instruction without worrying about an operator inadvertently taking control of the instruction. In this example, you have the program set the ProgProgReq input during the startup, and then clear the ProgProgReq input once the startup was complete. Once the ProgProgReq input is cleared, the instruction remains in Program control until it receives a request to change. For example, the operator could set the

OperOperReq input from a faceplate to take over control of that instruction.

The following example shows how to lock an instruction into Program control.

656

When StartupSequenceActive is set, the PIDE instruction is placed in Program control and

Manual mode. The StartupCV value is used as the loop output.

Operator request inputs to an instruction are always cleared by the instruction when it executes. This allows operator interfaces to work with these instructions by merely setting the desired mode request bit. You don’t have to program the operator interface to reset the request bits. For example, if an operator interface sets the OperAutoReq input to a PIDE instruction, when the PIDE instruction executes, it determines what the appropriate response should be and clears the OperAutoReq.

Program request inputs are not normally cleared by the instruction because these are normally wired as inputs into the instruction. If the instruction clears these inputs, the input would just get set again by the wired input. There might be situations where you want to use other logic to set the Program requests in such a manner that you want the Program requests to be cleared by the instruction. In this case, you can set the ProgValueReset input and the instruction will always clear the Program mode request inputs when it executes.




In this example, a rung of ladder logic in another routine is used to one-shot latch a ProgAutoReq to a PIDE instruction when a pushbutton is pushed.

Because the PIDE instruction automatically clears the Program mode requests, you don’t have to write any ladder logic to clear the ProgAutoReq after the routine executes, and the PIDE instruction will receive only one request to go to Auto every time the pushbutton is pressed.

When the TIC101AutoReq Pushbutton is pressed, one-shot latch ProgAutoReq for the PIDE instruction TIC101.

TIC101 has been configured with the ProgValueReset input set, so when the PIDE instruction executes, it automatically clears ProgAutoReq.



657


Notes:

658



Appendix

C

Structured Text Programming

Introduction

This appendix describes issues that are unique with structured text programming. Review the information in this appendix to make sure you understand how your structured text programming will execute.

For Information About

Structured Text Syntax

Assignments

Expressions

Instructions

Constructs

Comments

See Page

659

661

663

670

671

687

Structured Text Syntax

Term

assignment

(see page 661 )

Structured text is a textual programming language that uses statements to define what to execute.

•

Structured text is not case sensitive.

•

Use tabs and carriage returns (separate lines) to make your structured text easier to read. They have no effect on the execution of the structured text.

Structured text is not case sensitive. Structured text can contain these components:

Definition

Use an assignment statement to assign values to tags.

The

:=

operator is the assignment operator.

Terminate the assignment with a semi colon “;”.

Examples

tag := expression;



659

Appendix C Structured Text Programming

Term

expression

(see page 663 )

Definition

An expression is part of a complete assignment or construct statement.

An expression evaluates to a number (numerical expression) or to a true or false state (BOOL expression).

Examples

instruction

(see page 670)

An expression contains: tags A named area of the memory where data is stored

(BOOL, SINT,INT,DINT, REAL, string).

immediates A constant value.

operators A symbol or mnemonic that specifies an operation within an expression.

value1

4

tag1 + tag2

tag1 >= value1

function(tag1) functions When executed, a function yields one value. Use parentheses to contain the operand of a function.

Even though their syntax is similar, functions differ from instructions in that functions can only be used in expressions. Instructions cannot be used in expressions.

An instruction is a standalone statement.

instruction();

An instruction uses parenthesis to contain its operands.

Depending on the instruction, there can be zero, one, or multiple operands.

instruction(operand);

When executed, an instruction yields one or more values that are part of a data structure.

instruction(operand1, operand2,operand3);

Terminate the instruction with a semi colon “;”.

Even though their syntax is similar, instructions differ from functions in that instructions cannot be used in expressions. Functions can only be used in expressions.

660



Structured Text Programming Appendix C

Term

construct

(see page 671 ) comment

(see page 687 )

Definition

A conditional statement used to trigger structured text code (i.e, other statements).

Terminate the construct with a semi colon “;”.

Examples

IF...THEN

CASE

FOR...DO

WHILE...DO

REPEAT...UNTIL

EXIT

//comment

Text that explains or clarifies what a section of structured text does.

•

Use comments to make it easier to interpret the structured text.

•

Comments do not affect the execution of the structured text.

•

Comments can appear anywhere in structured text.

(*start of comment . . .

end of comment*)

/*start of comment . . .

end of comment*/

Assignments

Use an assignment to change the value stored within a tag. An assignment has this syntax:

tag := expression ; where:

;

Component

tag

:=

expression

Description

represents the tag that is getting the new value the tag must be a BOOL, SINT, INT, DINT, or REAL is the assignment symbol represents the new value to assign to the tag

If

tag is this data type:

Use this type of expression:

BOOL BOOL expression

SINT numeric expression

INT

DINT

REAL ends the assignment



661


The tag retains the assigned value until another assignment changes the value.

The expression can be simple, such as an immediate value or another tag name, or the expression can be complex and include several operators and/or functions. See the next section “ Expressions “on page 663 for details.

Specify a non-retentive assignment

The non-retentive assignment is different from the regular assignment described above in that the tag in a non-retentive assignment is reset to zero each time the controller:

• enters the RUN mode

• leaves the step of an SFC if you configure the SFC for Automatic reset

(This applies only if you embed the assignment in the action of the step or use the action to call a structured text routine via a JSR instruction.)

A non-retentive assignment has this syntax:

tag [:=] expression ; where:

;

Component

tag

[:=]

expression

Description

represents the tag that is getting the new value the tag must be a BOOL, SINT, INT, DINT, or REAL is the non-retentive assignment symbol represents the new value to assign to the tag

If

tag is this data type:

Use this type of expression:

BOOL BOOL expression

SINT numeric expression

INT

DINT

REAL ends the assignment

662



Expressions


Assign an ASCII character to a string

Use the assignment operator to assign an ASCII character to an element of the

DATA member of a string tag. To assign a character, specify the value of the character or specify the tag name, DATA member, and element of the character. For example:

This is OK

string1.DATA[0]:= 65; string1.DATA[0]:= string2.DATA[0];

This is not OK.

string1.DATA[0] := A; string1 := string2;

To add or insert a string of characters to a string tag, use either of these ASCII string instructions:

To

add characters to the end of a string insert characters into a string


CONCAT

INSERT

An expression is a tag name, equation, or comparison. To write an expression, use any of the following:

• tag name that stores the value (variable)

• number that you enter directly into the expression (immediate value)

• functions, such as: ABS, TRUNC

• operators, such as: +, -, <, >, And, Or

As you write expressions, follow these general rules:

•

Use any combination of upper-case and lower-case letter. For example, these three variations of "AND" are acceptable: AND, And, and.

•

For more complex requirements, use parentheses to group expressions within expressions. This makes the whole expression easier to read and ensures that the expression executes in the desired sequence. See

“ Determine the order of execution “on page 669 .



663


In structured text, you use two types of expressions:

BOOL expression

: An expression that produces either the BOOL value of 1

(true) or 0 (false).

•

A bool expression uses bool tags, relational operators, and logical operators to compare values or check if conditions are true or false.

For example, tag1>65.

•

A simple bool expression can be a single BOOL tag.

•

Typically, you use bool expressions to condition the execution of other logic.

Numeric expression

: An expression that calculates an integer or floating-point value.

•

A numeric expression uses arithmetic operators, arithmetic functions, and bitwise operators. For example, tag1+5.

•

Often, you nest a numeric expression within a bool expression. For example, (tag1+5)>65.

Use the following table to choose operators for your expressions:

If You Want To

Calculate an arithmetic value

Compare two values or strings

Check if conditions are true or false

Compare the bits within values

Then

“ Use arithmetic operators and functions “on page 665 .

“ Use relational operators “on page 666 .

“ Use logical operators “on page 668 .

“ Use bitwise operators “on page 669 .

664




Use arithmetic operators and functions

You can combine multiple operators and functions in arithmetic expressions.

Arithmetic operators calculate new values.

To

add subtract/negate multiply exponent (x to the power of y) divide modulo-divide

Use This Operator

-

+

*

**

/

MOD

Optimal Data Type

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

DINT, REAL

Arithmetic functions perform math operations. Specify a constant, a non-boolean tag, or an expression for the function.

For

absolute value arc cosine arc sine arc tangent cosine radians to degrees natural log log base 10 degrees to radians sine square root tangent truncate

Use This Function Optimal Data Type

ABS (

numeric_expression)

ACOS (


ASIN (


ATAN (


COS (


DEG (

numeric_expression)

LN (


LOG (


DINT, REAL

REAL

REAL

REAL

REAL

DINT, REAL

REAL

REAL

RAD (


SIN (


SQRT (


TAN (


DINT, REAL

REAL

DINT, REAL

REAL

TRUNC (


DINT, REAL



665


For example:

Use This Format Example

For This Situation

value1 operator value2

If gain_4 and gain_4_adj are DINT tags and your specification says: "Add 15 to gain_4 and store the result in gain_4_adj."

operator value1

If alarm and high_alarm are DINT tags and your specification says: “Negate high_alarm and store the result in alarm.”

function(numeric_expression)

If overtravel and overtravel_POS are DINT tags and your specification says: “Calculate the absolute value of overtravel and store the result in

overtravel_POS.”

value1 operator

(function((value2+value3)/2)

If adjustment and position are DINT tags and

sensor1 and sensor2 are REAL tags and your specification says: “Find the absolute value of the average of sensor1 and sensor2, add the

adjustment, and store the result in position.”

You’d Write

gain_4_adj := gain_4+15; alarm:=

-high_alarm; overtravel_POS :=

ABS(overtravel); position := adjustment +

ABS((sensor1 + sensor2)/2);

Use relational operators

Relational operators compare two values or strings to provide a true or false result. The result of a relational operation is a BOOL value:

If The Comparison Is

true false

The Result Is

1

0

Use the following relational operators:

For This Comparison


<=

>

>=

<>


=

<


DINT, REAL, string

DINT, REAL, string

DINT, REAL, string

DINT, REAL, string

DINT, REAL, string

DINT, REAL, string

666




For example:

Use This Format

value1 operator value2 stringtag1 operator stringtag2 char1 operator char2

Example


If temp is a DINT tag and your specification says: “If temp is less than 100

°

then…”

If bar_code and dest are string tags and your specification says: “If bar_code equals dest then…”

You’d Write

IF temp<100 THEN...

IF bar_code=dest THEN...

If bar_code is a string tag and your specification says: “If bar_code.DATA[0] equals

’A’ then…”

IF bar_code.DATA[0]=65

THEN...

To enter an ASCII character directly into the expression, enter the decimal value of the character.

bool_tag :=

bool_expressions

If count and length are DINT tags, done is a

BOOL tag, and your specification says ”If count is greater than or equal to length, you are done counting.” done := (count >= length);

How Strings Are Evaluated

The hexadecimal values of the ASCII characters determine if one string is less than or greater than another string.

•

When the two strings are sorted as in a telephone directory, the order of the strings determines which one is greater. s e r l e s e r a t g r e

B a ab


1ab $31$61$62

1b

A

AB

$31$62

$41

$41$42

$42

$61

$61$62

AB B

•


•

Characters are case sensitive. Upper case “A” ($41) is not equal to lower case “a” ($61).

For the decimal value and hex code of a character, see the back cover of this manual.



667


Use logical operators

Logical operators let you check if multiple conditions are true or false. The result of a logical operation is a BOOL value:

If The Comparison Is

true false

The Result Is

1

0

Use the following logical operators:

For

logical AND logical OR logical exclusive OR logical complement


&, AND

OR

XOR

NOT

For example:

Data Type

BOOL

BOOL

BOOL

BOOL

Use This Format

BOOLtag

NOT

BOOLtag

expression1 & expression2

expression1 OR expression2

expression1 XOR expression2

BOOLtag := expression1 &

expression2

Example


If photoeye is a BOOL tag and your specification says: “If photoeye is on then…”

If photoeye is a BOOL tag and your specification says: “If photoeye is off then…”

You’d Write

IF photoeye THEN...

IF NOT photoeye THEN...

IF photoeye & (temp<100)

THEN...

If photoeye is a BOOL tag, temp is a DINT tag, and your specification says: “If photoeye is on and temp is less than 100

°

then…”.

If photoeye is a BOOL tag, temp is a DINT tag, and your specification says: “If photoeye is on or temp is less than 100

°

then…”.

If photoeye1 and photoeye2 are BOOL tags and your specification says: “If:

IF photoeye OR (temp<100)

THEN...

IF photoeye1 XOR photoeye2 THEN...

•

photoeye1 is on while photoeye2 is off or

•

photoeye1 is off while photoeye2 is on then…"

If photoeye1 and photoeye2 are BOOL tags,

open is a BOOL tag, and your specification says:

“If photoeye1 and photoeye2 are both on, set

open to true”.

open := photoeye1 & photoeye2;

668




Use This Format

value1 operator value2

Use bitwise

operators

Bitwise operators manipulate the bits within a value based on two values.

For

bitwise AND bitwise OR bitwise exclusive OR bitwise complement


&, AND

OR

XOR

NOT


DINT

DINT

DINT

DINT

For example:

Example


If input1, input2, and result1 are DINT tags and your specification says: “Calculate the bitwise result of

input1 and input2. Store the result in result1.”

You’d Write

result1 := input1 AND input2;

Determine the order of execution

6.

7.

8.

9.

10.

11.

12.

3.

4.

5.

Order

1.

2.

The operations you write into an expression are performed in a prescribed order, not necessarily from left to right.

•


•

If an expression contains multiple operators or functions, group the conditions in parenthesis "( )" . This ensures the correct order of execution and makes it easier to read the expression.

Operation

( ) function (…)

**

−

(negate)

NOT

*, /, MOD

+, - (subtract)

<, <=, >, >=

=, <>

&, AND

XOR

OR



669


Instructions

Structured text statements can also be instructions. See the Locator Table at the beginning of this manual for a list of the instructions available in structured text. A structured text instruction executes each time it is scanned. A structured text instruction within a construct executes every time the conditions of the construct are true. If the conditions of the construct are false, the statements within the construct are not scanned. There is no rung-condition or state transition that triggers execution.

This differs from function block instructions that use EnableIn to trigger execution. Structured text instructions execute as if EnableIn is always set.

This also differs from relay ladder instructions that use rung-condition-in to trigger execution. Some relay ladder instructions only execute when rung-condition-in toggles from false to true. These are transitional relay ladder instructions. In structured text, instructions will execute each time they are scanned unless you pre-condition the execution of the structured text instruction.

For example, the ABL instruction is a transitional instruction in relay ladder. In this example, the ABL instruction only executes on a scan when tag_xic transitions from cleared to set. The ABL instruction does not execute when

tag_xic stays set or when tag_xic is cleared.

In structured text, if you write this example as:

IF tag_xic THEN ABL(0,serial_control);

END_IF; the ABL instruction will execute every scan that tag_xic is set, not just when

tag_xic transitions from cleared to set.

670




If you want the ABL instruction to execute only when tag_xic transitions from cleared to set, you have to condition the structured text instruction. Use a one shot to trigger execution.

osri_1.InputBit := tag_xic;

OSRI(osri_1);


ABL(0,serial_control);

END_IF;

Constructs

Constructs can be programmed singly or nested within other constructs.

If You Want To

do something if or when specific conditions occur select what to do based on a numerical value do something a specific number of times before doing anything else keep doing something as long as certain conditions are true keep doing something until a condition is true

Use This Construct

IF...THEN

CASE...OF

FOR...DO

WHILE...DO

REPEAT...UNTIL


structured text structured text structured text structured text structured text

See Page

672

675

678

681

684

Some key words are reserved for future use

These constructs are not available:

•

GOTO

•

REPEAT

RSLogix 5000 software will not let you use them as tag names or constructs.



671


IF...THEN

Use IF…THEN to do something if or when specific conditions occur.

Operands:

IF bool_expression THEN

<statement>;

END_IF;

Structured Text

Operand

bool_ expression

Type

BOOL

Format

tag expression

Enter

BOOL tag or expression that evaluates to a BOOL value (BOOL expression)

Description:

The syntax is: optional optional

IF bool_expression1 THEN

<statement >;

.

.

.

ELSIF bool_expression2 THEN

<statement>;

.

.

.

ELSE

<statement>;

.

.

.

END_IF; statements to execute when

bool_expression1 is true statements to execute when

bool_expression2 is true statements to execute when both expressions are false

To use ELSIF or ELSE, follow these guidelines:

1.

To select from several possible groups of statements, add one or more

ELSIF statements.

•

Each ELSIF represents an alternative path.

•

Specify as many ELSIF paths as you need.

•

The controller executes the first true IF or ELSIF and skips the rest of the ELSIFs and the ELSE.

2.

To do something when all of the IF or ELSIF conditions are false, add an ELSE statement.

672




The following table summarizes different combinations of IF, THEN, ELSIF, and ELSE.

If You Want To

do something if or when conditions are true choose from alternative statements

(or groups of statements) based on input conditions

And

do nothing if conditions are false

Use This Construct

IF…THEN do something else if conditions are false IF…THEN…ELSE do nothing if conditions are false IF…THEN…ELSIF assign default statements if all conditions are false

IF…THEN…ELSIF…ELSE


not affected


none

Example 1:

IF…THEN

If You Want This

IF rejects > 3 then conveyor = off (0) alarm = on (1)

Enter This Structured Text

IF rejects > 3 THEN conveyor := 0; alarm := 1;

END_IF;

Example 2:

IF…THEN…ELSE


If conveyor direction contact = forward (1) then light = off

Otherwise light = on


IF conveyor_direction THEN

ELSE light := 0; light [:=] 1;

END_IF;

The [:=] tells the controller to clear light whenever the controller:






673


Example 3:

IF…THEN…ELSIF


If sugar low limit switch = low (on) and sugar high limit switch = not high (on) then inlet valve = open (on)

Until sugar high limit switch = high (off)


IF Sugar.Low & Sugar.High THEN

Sugar.Inlet [:=] 1;

ELSIF NOT(Sugar.High) THEN

Sugar.Inlet := 0;

END_IF;

The [:=] tells the controller to clear Sugar.Inlet whenever the controller:





If tank temperature > 100 then pump = slow

If tank temperature > 200 then pump = fast otherwise pump = off

Example 4:

IF…THEN…ELSIF…ELSE


IF tank.temp > 200 THEN pump.fast :=1; pump.slow :=0; pump.off :=0;

ELSIF tank.temp > 100 THEN pump.fast :=0; pump.slow :=1; pump.off :=0;

ELSE pump.fast :=0; pump.slow :=0; pump.off :=1;

END_IF;

674




CASE...OF

Use CASE to select what to do based on a numerical value.

Operands:

CASE numeric_expression OF

selector1: statement;

selectorN: statement;

ELSE

statement;

END_CASE;

Structured Text

Operand

numeric_ expression selector

Type

SINT

INT

DINT

REAL

SINT

INT

DINT

REAL

Format

tag expression

Enter

tag or expression that evaluates to a number (numeric expression) immediate same type as

numeric_expression

IMPORTANT

If you use REAL values, use a range of values for a selector because a REAL value is more likely to be within a range of values than an exact match of one, specific value.

Description:

The syntax is: specify as many alternative selector values (paths) as you need

CASE numeric_expression OF

selector1 : <statement>;

.

.

.


.

.

.


.

.

.

statements to execute when

numeric_expression = selector1 statements to execute when

numeric_expression = selector2 statements to execute when

numeric_expression = selector3



675

Appendix C Structured Text Programming optional

ELSE

<statement>;

.

.

.

statements to execute when

numeric_expression

≠

any selector

END_CASE;

See the table on the next page for valid selector values.

The syntax for entering the selector values is:

When Selector Is

one value multiple, distinct values

Enter

value: statement

value1, value2, valueN : <statement> a range of values

Use a comma (,) to separate each value.

value1..valueN : <statement> distinct values plus a range of values

Use two periods (..) to identify the range.

valuea, valueb, value1..valueN : <statement>

The CASE construct is similar to a switch statement in the C or C++ programming languages. However, with the CASE construct the controller executes only the statements that are associated with the first matching selector value. Execution always breaks after the statements of that selector and goes to the

END_CASE statement.


not affected


none

676




Example


If recipe number = 1 then

Ingredient A outlet 1 = open (1)

Ingredient B outlet 4 = open (1)

If recipe number = 2 or 3 then



If recipe number = 4, 5, 6, or 7 then



If recipe number = 8, 11, 12, or 13 then



Otherwise all outlets = closed (0)


CASE recipe_number OF

1: Ingredient_A.Outlet_1 :=1;

2,3:

Ingredient_B.Outlet_4 :=1;

Ingredient_A.Outlet_4 :=1;


4..7: Ingredient_A.Outlet_4 :=1;


8,11..13

Ingredient_A.Outlet_1 :=1;


ELSE

Ingredient_A.Outlet_1 [:=]0;

Ingredient_A.Outlet_4 [:=]0;

Ingredient_B.Outlet_2 [:=]0;

Ingredient_B.Outlet_4 [:=]0;

END_CASE;

The [:=] tells the controller to also clear the outlet tags whenever the controller:






677


FOR…DO

Use the FOR…DO loop to do something a specific number of times before doing anything else.

Operands:

Structured Text

FOR count:= initial_value TO

final_value BY increment DO

<statement>;

END_FOR;

Operand

count initial_ value final_ value

DINT

increment

SINT

INT

DINT

INT

DINT

SINT

INT

Type

SINT

INT

DINT

SINT

Format

tag

Description

tag to store count position as the

FOR…DO executes tag expression immediate tag expression immediate tag expression immediate must evaluate to a number specifies initial value for count specifies final value for count, which determines when to exit the loop

(optional) amount to increment count each time through the loop

If you don’t specify an increment, the count increments by 1.

IMPORTANT

Make sure that you do not iterate within the loop too many times in a single scan.

•

The controller does not execute any other statements in the routine until it completes the loop.

•

If the time that it takes to complete the loop is greater than the watchdog timer for the task, a major fault occurs.

•

Consider using a different construct, such as IF...THEN.

678




Description:

The syntax is: optional {

FOR count := initial_value

TO final_value

BY increment optional

DO

<statement>;

IF bool_expression THEN

EXIT;

END_IF;

If you don’t specify an increment, the loop increments by 1.

If there are conditions when you want to exit the loop early, use other statements, such as an IF...THEN construct, to condition an EXIT statement.

END_FOR;

The following diagrams show how a FOR...DO loop executes and how an

EXIT statement leaves the loop early.

Done x number of times?

no statement 1 statement 2 statement 3 yes rest of the routine

The FOR…DO loop executes a specific number of times.

Done x number of times?

no statement 1 statement 2 yes statement 3 yes no rest of the routine

To stop the loop before the count reaches the last value, use an EXIT statement.


not affected



the construct loops too long

Fault Type

6

Fault Code

1



679


Example 1:


Clear bits 0 - 31 in an array of BOOLs:

1. Initialize the subscript tag to 0.

2. Clear array[ subscript ] . For example, when subscript

= 5, clear array[5].


For subscript:=0 to 31 by 1 do array[subscript] := 0;

End_for;

3. Add 1 to subscript.

4. If subscript is

≤

Otherwise, stop.

Example 2:


A user-defined data type (structure) stores the following information about an item in your inventory:

•

Barcode ID of the item (string data type)

•

Quantity in stock of the item (DINT data type)

An array of the above structure contains an element for each different item in your inventory. You want to search the array for a specific product (use its bar code) and determine the quantity that is in stock.


SIZE(Inventory,0,Inventory_Items);

For position:=0 to Inventory_Items - 1 do

If Barcode = Inventory[position].ID then

Quantity := Inventory[position].Qty;

Exit;

End_if;

End_for;

1. Get the size (number of items) of the Inventory array and store the result in Inventory_Items (DINT tag).

2. Initialize the position tag to 0.

3. If Barcode matches the ID of an item in the array, then: a. Set the Quantity tag = Inventory[position].Qty. This produces the quantity in stock of the item.

b. Stop.

Barcode is a string tag that stores the bar code of the item for which you are searching. For example, when position =

5, compare Barcode to Inventory[5].ID.

4. Add 1 to position.

5. If position is

≤ element numbers start at 0, the last element is 1 less than the number of elements in the array.

Otherwise, stop.

680




WHILE…DO

Use the WHILE…DO loop to keep doing something as long as certain conditions are true.

Operands:

WHILE bool_expression DO

<statement>;

END_WHILE;

Structured Text

Operand

bool_ expression

Type

BOOL

Format

tag expression

Enter

BOOL tag or expression that evaluates to a BOOL value

IMPORTANT


•


•


•


Description:

The syntax is: optional

WHILE bool_expression1 DO

<statement>;


EXIT;

END_IF;

END_WHILE; statements to execute while

bool_expression1 is true




681


BOOL expression true statement 1 statement 2 statement 3 false

The following diagrams show how a WHILE...DO loop executes and how an

EXIT statement leaves the loop early.

false

BOOL expression true statement 1 rest of the routine

While the

bool_expression is true, the controller executes only the statements within the WHILE…DO loop.

statement 2 statement 3 yes no rest of the routine

To stop the loop before the conditions are true, use an

EXIT statement.


not affected




Example 1:

Fault Type

6

Fault Code

1


The WHILE...DO loop evaluates its conditions first. If the conditions are true, the controller then executes the statements within the loop.

This differs from the REPEAT...UNTIL loop because the

REPEAT...UNTIL loop executes the statements in the construct and then determines if the conditions are true before executing the statements again. The statements in a

REPEAT...UNTIL loop are always executed at least once. The statements in a WHILE...DO loop might never be executed.


pos := 0;

While ((pos <= 100) & structarray[pos].value

<> targetvalue)) do pos := pos + 2;

String_tag.DATA[pos] := SINT_array[pos]; end_while;

682




Example 2:


Move ASCII characters from a SINT array into a string tag. (In a SINT array, each element holds one character.) Stop when you reach the carriage return.

1. Initialize Element_number to 0.

2. Count the number of elements in SINT_array (array that contains the ASCII characters) and store the result in

SINT_array_size (DINT tag).

3. If the character at SINT_array[element_number] = 13

(decimal value of the carriage return), then stop.

4. Set String_tag[element_number] = the character at

SINT_array[element_number].


element_number := 0;

SIZE(SINT_array, 0, SINT_array_size);

While SINT_array[element_number] <> 13 do

String_tag.DATA[element_number] :=

SINT_array[element_number]; element_number := element_number + 1;

String_tag.LEN := element_number;

If element_number = SINT_array_size then exit; end_if; end_while;

5. Add 1 to element_number. This lets the controller check the next character in SINT_array.

6. Set the Length member of String_tag = element_number.

(This records the number of characters in String_tag so far.)

7. If element_number = SINT_array_size, then stop. (You are at the end of the array and it does not contain a carriage return.)

8. Go to 3.



683


REPEAT…UNTIL

Use the REPEAT…UNTIL loop to keep doing something until conditions are true.

Operands:

REPEAT

<statement>;

UNTIL bool_expression

END_REPEAT;

Structured Text

Operand

bool_ expression

Type

BOOL

Format

tag expression

Enter

BOOL tag or expression that evaluates to a BOOL value (BOOL expression)

IMPORTANT


•


•


•


Description:

The syntax is: optional

REPEAT

<statement>;


EXIT;

END_IF;

UNTIL bool_expression1

END_REPEAT; statements to execute while

bool_expression1 is false


684



Structured Text Programming Appendix C statement 1 statement 2 statement 3

BOOL expression false true

The following diagrams show how a REPEAT...UNTIL loop executes and how an EXIT statement leaves the loop early.

statement 1 statement 2 statement 3 yes rest of the routine no

BOOL expression false true

While the

bool_expression is false, the controller executes only the statements within the

REPEAT…UNTIL loop.

rest of the routine

To stop the loop before the conditions are false, use an EXIT statement.


not affected




Example 1:

Fault Type

6

Fault Code

1


The REPEAT...UNTIL loop executes the statements in the construct and then determines if the conditions are true before executing the statements again.

This differs from the WHILE...DO loop because the WHILE...DO

The WHILE...DO loop evaluates its conditions first. If the conditions are true, the controller then executes the statements within the loop. The statements in a

REPEAT...UNTIL loop are always executed at least once. The statements in a WHILE...DO loop might never be executed.


pos := -1;

REPEAT pos := pos + 2;

UNTIL ((pos = 101) OR

(structarray[pos].value = targetvalue)) end_repeat;



685


Example 2:


Move ASCII characters from a SINT array into a string tag. (In a SINT array, each element holds one character.) Stop when you reach the carriage return.

1. Initialize Element_number to 0.

2. Count the number of elements in SINT_array (array that contains the ASCII characters) and store the result in

SINT_array_size (DINT tag).

3. Set String_tag[element_number] = the character at

SINT_array[element_number].

4. Add 1 to element_number. This lets the controller check the next character in SINT_array.

5. Set the Length member of String_tag = element_number.

(This records the number of characters in String_tag so far.)


element_number := 0;

SIZE(SINT_array, 0, SINT_array_size);

Repeat

String_tag.DATA[element_number] :=

SINT_array[element_number]; element_number := element_number + 1;

String_tag.LEN := element_number;

If element_number = SINT_array_size then exit; end_if;

Until SINT_array[element_number] = 13 end_repeat;

6. If element_number = SINT_array_size, then stop. (You are at the end of the array and it does not contain a carriage return.)

7. If the character at SINT_array[element_number] = 13

(decimal value of the carriage return), then stop.

Otherwise, go to 3.

686



Comments


To make your structured text easier to interpret, add comments to it.

•

Comments let you use plain language to describe how your structured text works.

•

Comments do not affect the execution of the structured text.

To add comments to your structured text:

To Add A Comment

on a single line at the end of a line of structured text

Use One Of These Formats

//comment

(*comment*) within a line of structured text

/*comment*/

(*comment*) that spans more than one line

/*comment*/

(*start of comment . . . end of

comment*)

/*start of comment . . . end of

comment*/



687


Format

//comment

(*comment*)

/*comment*/

For example:

Example

At the beginning of a line

//Check conveyor belt direction

IF conveyor_direction THEN...

At the end of a line

ELSE //If conveyor isn’t moving, set alarm light light := 1;

END_IF;

Sugar.Inlet[:=]1;(*open the inlet*)

IF Sugar.Low (*low level LS*)& Sugar.High (*high level

LS*)THEN...

(*Controls the speed of the recirculation pump. The speed depends on the temperature in the tank.*)

IF tank.temp > 200 THEN...

Sugar.Inlet:=0;/*close the inlet*/

IF bar_code=65 /*A*/ THEN...

/*Gets the number of elements in the Inventory array and stores the value in the Inventory_Items tag*/

SIZE(Inventory,0,Inventory_Items);

688



Index

A

ABL instruction

570

ABS instruction

277

absolute value

277

ACB instruction

573

ACL instruction

575

ACS instruction

532

ADD instruction

252

addition

252

advanced math instructions

introduction 539

LN 540

LOG 543

XPY 546

AFI instruction

456

AHL instruction

577

alarms

504

alarms and events instructions

alarm status 69

ALMA, analog alarm 42 buffer alarms 69 configuration 63 controller-based alarm execution 72 message text 65 programmatically access 70 suppress or disable alarms 71

all mode

330

ALMA instruction

42

ALMD instruction, alarms and events instructions

ALMD 30

always false instruction

456

AND instruction

303

arc cosine

532

arc sine

529

arc tangent

535

ARD instruction

581

arithmetic operators

structured text 665

arithmetic status flags

overflow 648

ARL instruction

585

array instructions

AVE 365

BSL 386

BSR 390

COP 355

CPS 355

DDT 486

FAL 335

FBC 478

FFL 394

FFU 400 file/misc.

329

FLL 361

FSC 346

LFL 406

LFU 412 mode of operation 330

RES 141 sequencer 419 shift 385

SIZE 381

SQI 420

SQL 428

SQO 424

SRT 370

STD 375

ASCII

structured text assignment 663

ASCII chars in buffer

573

ASCII clear buffer

575

ASCII handshake lines

577

ASCII instructions

ABL 570

ACB 573

ACL 575

AHL 577

ARD 581

ARL 585

AWA 589

AWT 594

CONCAT 601

DELETE 603

DTOS 619

FIND 605

INSERT 607

LOWER 625

MID 609

RTOS 621

STOD 614

STOR 616

SWPB 299

UPPER 623

ASCII read

581

ASCII read line

585

ASCII test for buffer line

570

ASCII write

594

ASCII write append

589

ASN instruction

529

assignment

ASCII character 663 non-retentive 662 retentive 661



689

Index

690

assume data available

645

,

647

ATN instruction

535

attributes

converting data types 635 immediate values 635

AVE instruction

365

average

365

AWA instruction

589

AWT instruction

594

B

BAND

317

bit field distribute

291

bit field distribute with target

294

bit instructions

introduction 77

ONS 88

OSF 94

OSFI 99

OSR 91

OSRI 96

OTE 82

OTL 84

OTU 86

XIO 80

bit shift left

386

bit shift right

390

bitwise AND

303

bitwise exclusive OR

310

bitwise NOT

314

bitwise operators

structured text 669

bitwise OR

306

BNOT

326

BOOL expression

structured text 663

Boolean AND

317

Boolean Exclusive OR

323

Boolean NOT

326

Boolean OR

320

BOR

320

break

473

BRK instruction

473

BSL instruction

386

BSR instruction

390

BTD instruction

291

BTDT instruction

294

BXOR

323

C cache

connection 173

CASE

675

clear

297

CLR instruction

297

CMP instruction

206

comments

structured text 687

common attributes

635 converting data types 635 immediate values 635

compare

206

compare instructions

CMP 206

EQU 211 expression format 209

,

352

GEQ 215

GRT 219 introduction 205

LEQ 223

LES 227

LIM 231

MEQ 237

NEQ 242 order of operation 209

,

353 valid operators 208

,

352

COMPARE structure

479

,

487

compute

248

compute instructions

ABS 277

ADD 252

CPT 248

DIV 261 expression format 250

,

345 introduction 247

MOD 266

MUL 258

NEG 274 order of operation 251

,

345

SQR 270

SUB 255 valid operators 250

,

344

CONCAT instruction

601

configuring

159

MSG instruction 159

PID instruction 502

connection

cache 173

connector

function block diagram 641

construct



Index structured text 671

CONTROL structure

336

,

346

,

366

,

370

,

375

,

386

,

390

,

395

,

401

,

406

,

407

,

413

,

420

,

424

,

428

control structure

448

CONTROLLER object

180

CONTROLLERDEVICE object

181

conversion instructions

DEG 550

FRD 559 introduction 549

RAD 553

TOD 556

TRN 561

convert to BCD

556

convert to integer

559

converting data types

635

COP instruction

355

copy

355

COS instruction

523

cosine

523

count down

132

count up

128

count up/down

136

counter instructions

CTD 132

CTU 128

CTUD 136 introduction 103

RES 141

COUNTER structure

128

,

132

CPS instruction

355

CPT instruction

248

CST object

183

CTD instruction

132

CTU instruction

128

CTUD instruction

136

D data transitional

494

DDT instruction

operands 486 search mode 488

deadband

514

debug instructions

627

DEG instruction

550

degree

550

DELETE instruction

603

description

structured text 687

DF1 object

184

diagnostic detect

486

digital alarm

30

DINT to String

619

DIV instruction

261

division

261

document

structured text 687

DTOS instruction

619

DTR instruction

494

E elements

SIZE instruction 381

end of transition instruction

458

EOT instruction

458

EQU instruction

211

equal to

211

error codes

ASCII 568

MSG instruction 152

EVENT instruction

464

event task

configure 195 trigger via consumed tag 201 trigger via EVENT instruction 464

examine if open

80

execution order

644

exponential

546

expression

BOOL expression structured text 663 numeric expression structured text 663 order of execution structured text 669 structured text arithmetic operators 665 bitwise operators 669 functions 665 logical operators 668 overview 663 relational operators 666

expressions

format 209

,

250

,

345

,

352 order of operation 209

,

251

,

345

,

353 valid operators 208

,

250

,

344

,

352

F

FAL instruction



691

Index

692

mode of operation 330 operands 335

FAULTLOG object

187

FBC instruction

operands 478 search mode 480

FBD_BIT_FIELD_DISTRIBUTE structure

294

FBD_BOOLEAN_AND structure

317

FBD_BOOLEAN_NOT structure

326

FBD_BOOLEAN_OR structure

320

FBD_BOOLEAN_XOR structure

323

FBD_COMPARE structure

212

,

216

,

220

,

224

,

228

,

243

FBD_CONVERT structure

556

,

559

FBD_COUNTER structure

136

FBD_LIMIT structure

232

FBD_LOGICAL structure

304

,

307

,

311

,

315

FBD_MASK_EQUAL structure

238

FBD_MASKED_MOVE structure

288

FBD_MATH structure

253

,

256

,

259

,

262

,

267

,

275

,

547

FBD_MATH_ADVANCED structure

271

,

278

,

520

,

524

,

527

,

529

,

532

,

535

,

540

,

544

,

550

,

553

FBD_ONESHOT structure

96

,

99

FBD_TIMER structure

116

,

120

,

124

FBD_TRUNCATE structure

561

feedback loop


feedforward

515

FFL instruction

394

FFU instruction

400

FIFO load

394

FIFO unload

400

file arithmetic and logic

335

file bit comparison

478

file fill

361

file instructions. See array instructions file search and compare

346

FIND instruction

605

Find String

605

FLL instruction

361

FOR instruction

470

FOR…DO

678

for/break instructions

BRK 473

FOR 470 introduction 469

RET 474

FRD instruction

559

FSC instruction

mode of operation 330 operands 346

function block diagram

choose elements 641 create a scan delay 647 resolve a loop 645 resolve data flow between blocks 647

functions

structured text 665

GEQ instruction

215

get system value

176

greater than

219

greater than or equal to

215

GRT instruction

219

GSV instruction

objects 179 operands 176

I

G

ICON

641

IF...THEN

672

immediate output instruction

201

immediate values

635

incremental mode

333

inhibit

task 195

input reference

641

input wire connector

641

input/output instructions

GSV 176 introduction 143

IOT 201

MSG 144

SSV 176

INSERT instruction

607

Insert String

607

instructions

advanced math 539 alarms and events 29 array

ASCII conversion 611

ASCII serial port 565

ASCII string manipulation 599 bit 77 compare 205 compute 247



Index conversion 549 counter 103 debug 627 for/break 469 input/output 143 logical 281 math conversion 549 move 281 program control 433 sequencer 419 serial port 565 shift 385 special 477 string conversion 611 string manipulation 599 timer 103 trigonometric 519

IOT instruction

201

IREF

641

J

JMP instruction

434

,

627

,

631

JSR instruction

436

jump

434

,

627

,

631

jump to subroutine

436

JXR instruction

control structure 448

L label

434

,

627

,

631

latching data

642

LBL instruction

434

,

627

,

631

LEQ instruction

223

LES instruction

227

less than

227

less than or equal to

223

LFL instruction

406

LFU instruction

412

LIFO load

406

LIFO unload

412

LIM instruction

231

limit

231

LN instruction

540

log

base 10 543 natural 540

log base 10

543

LOG instruction

543

logical instructions

AND 303



introduction 281

NOT 314

OR 306

XOR 310

logical operators

structured text 668

lower case

625

LOWER instruction

625

M masked equal to

237

masked move

285

masked move with target

288

masks

495

master control reset

452

math conversion instructions

DEG 550

FRD 559 introduction 549

RAD 553

TOD 556

TRN 561

math operators

structured text 665

MCR instruction

452

MEQ instruction

237

message

144 cach connections 173 programming guidelines 175

MESSAGE object

188

MESSAGE structure

144

MID instruction

609

Middle String

609

mixing data types

635

MOD instruction

266

mode of operation

330

MODULE object

190

modulo division

266

MOTIONGROUP object

191

MOV instruction

283

move

283

move instructions

BTD 291

BTDT 294

CLR 297 introduction 281

MOV 283

MVM 285

MVMT 288

move/logical instructions

693

Index

694

BAND 317

BNOT 326

BOR 320

BXOR 323

MSG instruction

159 cache connection 173 communication method 172 error codes 152 operands 144 programming guidelines 175 structure 144

MUL instruction

258

multiplication

258

MVM instruction

285

MVMT instruction

288

N natural log

540

NEG instruction

274

negate

274

NEQ instruction

242

no operation

457

NOP instruction

457

not equal to

242

NOT instruction

314

numeric expression

663

numerical mode

331

O objects

CONTROLLER 180

CONTROLLERDEVICE 181

CST 183

DF1 184

FAULTLOG 187

GSV/SSV instruction 179

MESSAGE 188

MODULE 190

MOTIONGROUP 191

PROGRAM 192

ROUTINE 193

SERIALPORT 193

TASK 195

WALLCLOCKTIME 197

OCON

641

one shot

88

one shot falling

94

one shot falling with input

99

one shot rising

91

one shot rising with input

96



ONS instruction

88

operators

208

,

250

,

344

,

352 order of execution structured text 669

OR instruction

306

order of execution

644 structured text expression 669

order of operation

209

,

251

,

345

,

353

OREF

641

OSF instruction

94

OSFI instruction

99

OSR instruction

91

OSRI instruction

96

OTE instruction

82

OTL instruction

84

OTU instruction

86

output

enable or disable end-of-task processing

195 update immediately 201

output biasing

515

output energize

82

output latch

84

output reference

641

output unlatch

86

output wire connector

641

overflow conditions

648

overlap

check for task overlap 195

P pause SFC instruction

460

PID instruction

alarms 504 configuring 502 deadband 514 feedforward 515 operands 497 output biasing 515 scaling 505 tuning 503

PID structure

498

postscan

structured text 662

product codes

181

program control instructions

AFI 456

EOT 458

EVENT 464 introduction 433

Index

JMP 434

,

627

,

631

JSR 436

LBL 434

,

627

,

631

MCR 452

NOP 457

RET 436

SBR 436

TND 450

UID 454

UIE 454

PROGRAM object

192

program/operator control

overview 654

proportional, integral, and derivative

497

R

RAD instruction

553

radians

553

REAL to String

621

relational operators

structured text 666

REPEAT…UNTIL

684

RES instruction

141

reset

141

reset SFC instruction

462

RESULT structure

479

,

487

RET instruction

436

,

474

retentive timer on

112

retentive timer on with reset

124

return

436

,

474

ROUTINE object

193

RTO instruction

112

RTOR instruction

124

RTOS instruction

621

S

SBR instruction

436

scaling

505

scan delay


search mode

480

,

488

search string

605

sequencer input

420

sequencer instructions

introduction 419

SQI 420

SQL 428

SQO 424

sequencer load

428

sequencer output

424

serial port instructions

ABL 570

ACB 573

ACL 575

AHL 577

ARD 581

ARL 585

AWA 589

AWT 594 introduction 565

SERIAL_PORT_CONTROL structure

566

,

568

,

570

,

573

,

578

,

582

,

586

,

590

,

595

SERIALPORT object

193

set system value

176

SFP instruction

460

SFR instruction

462

shift instructions

BSL 386

BSR 390

FFL 394

FFU 400 introduction 385

LFL 406

LFU 412

SIN instruction

520

sine

520

size in elements

381

SIZE instruction

381

sort

370

special instructions

DDT 486

DTR 494

FBC 478 introduction 477

PID 497

SFP 460

SFR 462

SQI instruction

420

SQL instruction

428

SQO instruction

424

SQR instruction

270

square root

270

SRT instruction

370

SSV instruction

objects 179 operands 176

standard deviation

375

status

task 195

STD instructions

375



695

Index

696

STOD instruction

614

STOR instruction

616

string

evaluation in structured text 667

String Concatenate

601

string conversion instructions

DTOS 619 introduction 611

LOWER 625

RTOS 621

STOD 614

STOR 616

SWPB 299

UPPER 623

string data type

567

,

600

,

613

String Delete

603

string manipulation instructions

CONCAT 601

DELETE 603

FIND 605

INSERT 607 introduction 599

MID 609

STRING structure

567

,

600

,

613

String To DINT

614

String To REAL

616

structured text

arithmetic operators 665 assign ASCII character 663 assignment 661 bitwise operators 669

CASE 675 comments 687 components 659 contructs 671 evaluation of strings 667 expression 663

FOR…DO 678 functions 665

IF...THEN

672 logical operators 668 non-retentive assignment 662 numeric expression 663 relational operators 666

REPEAT…UNTIL 684

WHILE…DO 681

structures

COMPARE 479

,

487

CONTROL 336

,

346

,

366

,

370

,

375

,

386

,

390

,

395

,

401

,

406

,

407

,

413

,

420

,

424

,

428

COUNTER 128

,

132

FBD_BIT_FIELD_DISTRIBUTE 294

FBD_BOOLEAN_AND 317

FBD_BOOLEAN_NOT 326

FBD_BOOLEAN_OR 320

FBD_BOOLEAN_XOR 323

FBD_COMPARE 212

,

216

,

220

,

224

,

228

,

243

FBD_CONVERT 556

,

559

FBD_COUNTER 136

FBD_LIMIT 232

FBD_LOGICAL 304

,

307

,

311

,

315

FBD_MASK_EQUAL 238

FBD_MASKED_MOVE 288

FBD_MATH 253

,

256

,

259

,

262

,

267

,

275

,

547

FBD_MATH_ADVANCED 271

,

278

,

520

,

524

,

527

,

529

,

532

,

535

,

540

,

544

,

550

,

553

FBD_ONESHOT 96

,

99

FBD_TIMER 116

,

120

,

124

FBD_TRUNCATE 561

MESSAGE 144

PID 498

RES instruction 141

RESULT 479

,

487

SERIAL_PORT_CONTROL 566

,

568

,

570

,

573

,

578

,

582

,

586

,

590

,

595

STRING 567

,

600

,

613 string 567

,

600

,

613

TIMER 104

,

108

,

112

SUB instruction

255

subroutine

436

subtraction

255

swap byte

299

SWPB instruction

299

synchronous copy

355

T

TAN instruction

526

tangent

526

task

configure programmatically 195 inhibit 195 monitor 195 trigger event task 464 trigger via consumed tag 201

TASK object

195

temporary end

450

timeout

configure for event task 195

timer instructions

introduction 103



RES 141

RTO 112

RTOR 124

TOF 108

TOFR 120

TON 104

TONR 116

timer off delay

108

timer off delay with reset

120

timer on delay

104

timer on delay with reset

116

TIMER structure

104

,

108

,

112

timing modes

649

TND instruction

450

TOD instruction

556

TOF instruction

108

TOFR instruction

120

TON instruction

104

TONR instruction

116

trigger event task

464

trigger event task instruction

464

trigonometric instructions

ACS 532

ASN 529

ATN 535

COS 523 introduction 519

SIN 520

TAN 526

TRN instruction

561

truncate

561

tuning

503

U

UID instruction

454

UIE instruction

454

unresolved loop


update output

201

upper case

623

UPPER instruction

623

user interrupt disable

454

user interrupt enable

454

W

WALLCLOCKTIME object

197

WHILE…DO

681

X

X to the power of Y

546

XIO instruction

80

XOR instruction

310

XPY instruction

546

Index



697

Index

698



How Are We Doing?

Your comments on our technical publications will help us serve you better in the future.

Thank you for taking the time to provide us feedback.

You can complete this form and mail (or fax) it back to us or email us at

[email protected].

Pub. Title/Type Logix5000 Controllers General Instructions Reference Manual

Cat. No.

1756-L6x, 1768-L4x,

1769-L3x, 1789-L6x,

1794-L3x, 20D

Pub. No.

1756-RM003K-EN-P Pub. Date July 2008 Part No.

Please complete the sections below. Where applicable, rank the feature (1=needs improvement, 2=satisfactory, and 3=outstanding).

Overall Usefulness

1 2 3 How can we make this publication more useful for you?

Completeness

(all necessary information is provided)

1 2 3 Can we add more information to help you?

procedure/step illustration example explanation guideline definition feature other

Technical Accuracy

(all provided information is correct)

1 2 3 Can we be more accurate?

text illustration

Clarity

(all provided information is easy to understand)

1 2 3 How can we make things clearer?

Other Comments

You can add additional comments on the back of this form.

Your Name

Your Title/Function

Location/Phone

Would you like us to contact you regarding your comments?

___No, there is no need to contact me

___Yes, please call me

___Yes, please email me at _______________________

___Yes, please contact me via _____________________

Return this form to: Rockwell Automation Technical Communications, 1 Allen-Bradley Dr., Mayfield Hts., OH 44124-9705

Fax: 440-646-3525 Email: [email protected]

Publication CIG-CO521D-EN-P- July 2007


Other Comments

PLEASE FASTEN HERE (DO NOT STAPLE)

PLEASE FOLD HERE

BUSINESS REPLY MAIL

FIRST-CLASS MAIL PERMIT NO. 18235 CLEVELAND OH

POSTAGE WILL BE PAID BY THE ADDRESSEE

1 ALLEN-BRADLEY DR

MAYFIELD HEIGHTS OH 44124-9705


NO POSTAGE

NECESSARY

IF MAILED

IN THE

UNITED STATES

ASCII Character Codes

[ctrl-O] SI 15

[ctrl-P] DLE 16

[ctrl-Q] DC1 17

[ctrl-R] DC2 18

[ctrl-S] DC3 19

[ctrl-T] DC4 20

[ctrl-U] NAK 21

[ctrl-V] SYN 22

[ctrl-W] ETB 23

[ctrl-X] CAN 24

[ctrl-Y] EM 25

[ctrl-Z] SUB 26 ctrl-[ ESC 27

[ctrl-\] FS 28 ctrl-] GS

[ctrl-^] RS

29

30

[ctrl-_] US 31

Character Dec Hex

[ctrl-@] NUL 0 $00

[ctrl-A] SOH 1

[ctrl-B] STX 2

$01

$02

[ctrl-C] ETX 3

[ctrl-D] EOT 4

[ctrl-E] ENQ 5

[ctrl-F] ACK 6

$03

$04

$05

$06

[ctrl-G] BEL 7

[ctrl-H] BS 8

[ctrl-I] HT

[ctrl-J] LF

9

10

[ctrl-K] VT

[ctrl-L] FF

11

12

[ctrl-M] CR 13

[ctrl-N] SO 14

$07

$08

$09

$l ($0A)

$0B

$0C

$r ($0D)

$0E

$17

$18

$19

$1A

$1B

$1C

$13

$14

$15

$16

$0F

$10

$11

$12

$1D

$1E

$1F

7

8

5

6

9

;

:

<

=

>

?

3

4

1

2

/

0

.

-

,

+

)

*

(

‘

%

&

#

$

!

“


SPACE 32 $20

33

34

35

36

$21

$22

$23

$24

37

38

39

40

41

42

43

44

$29

$2A

$2B

$2C

$25

$26

$27

$28

53

54

55

56

57

58

59

60

61

62

63

49

50

51

52

45

46

47

48

$35

$36

$37

$38

$39

$3A

$3B

$3C

$31

$32

$33

$34

$2D

$2E

$2F

$30

$3D

$3E

$3F

U

V

W

X

Y

\

[

Z

]

^

_

S

T

Q

R

O

P

M

N

K

L

I

J

G

H

E

F

C

D

A

B


@ 64 $40

65

66

67

68

$41

$42

$43

$44

69

70

71

72

73

74

75

76

$49

$4A

$4B

$4C

$45

$46

$47

$48

85

86

87

88

89

90

91

92

93

94

95

81

82

83

84

77

78

79

80

$55

$56

$57

$58

$59

$5A

$5B

$5C

$51

$52

$53

$54

$4D

$4E

$4F

$50

$5D

$5E

$5F w x u v y

| z

{ t s r q o p m n

}

~

DEL l k j i g h f e c d a b

‘


96 $60

97

98

99

100

$61

$62

$63

$64

101

102

103

104

105

106

107

108

$65

$66

$67

$68

$69

$6A

$6B

$6C

109 $6D

110 $6E

111 $6F

112 $70

113 $71

114 $72

115 $73

116 $74

117 $75

118 $76

119 $77

120 $78

121 $79

122 $7A

123 $7B

124 $7C

125 $7D

126 $7E

127 $7F


Rockwell Automation

Support

Rockwell Automation provides technical information on the web to assist you in using its products. At http://support.rockwellautomation.com, you can find technical manuals, a knowledge base of FAQs, technical and application notes, sample code and links to software service packs, and a MySupport feature that you can customize to make the best use of these tools.

For an additional level of technical phone support for installation, configuration and troubleshooting, we offer TechConnect Support programs. For more information, contact your local distributor or Rockwell Automation representative, or visit http://support.rockwellautomation.com.

Installation Assistance

If you experience a problem with a hardware module within the first 24 hours of installation, please review the information that's contained in this manual. You can also contact a special Customer Support number for initial help in getting your module up and running:

United States

Outside United

States

1.440.646.3223

Monday – Friday, 8am – 5pm EST

Please contact your local Rockwell Automation representative for any technical support issues.

New Product Satisfaction Return

Rockwell 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:

United States

Outside United

States

Contact your distributor. You must provide a Customer Support case number (see phone number above to obtain one) to your distributor in order to complete the return process.

Please contact your local Rockwell Automation representative for return procedure.

Back Cover


702

Supersedes Publication 1756-RM003J-EN-P - July 2007 Copyright © 2008 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.


• FAST SHIPPING AND

DELIVERY

• TENS OF THOUSANDS OF

IN-STOCK ITEMS

• EQUIPMENT DEMOS

• HUNDREDS OF

MANUFACTURERS

SUPPORTED

• LEASING/MONTHLY

RENTALS

• ITAR CERTIFIED

SECURE ASSET SOLUTIONS

Artisan Technology Group is your source for quality new and certified-used/pre-owned equipment

SERVICE CENTER REPAIRS

Experienced engineers and technicians on staff at our full-service, in-house repair center

Instra

View

SM

REMOTE INSPECTION

Remotely inspect equipment before purchasing with our interactive website at

www.instraview.com

WE BUY USED EQUIPMENT

Sell your excess, underutilized, and idle used equipment

We also offer credit for buy-backs and trade-ins

www.artisantg.com/WeBuyEquipment

LOOKING FOR MORE INFORMATION?

Visit us on the web at

www.artisantg.com

for more information on price quotations, drivers, technical specifications, manuals, and documentation

Contact us:

(888) 88-SOURCE | [email protected] | www.artisantg.com