Rockwell Automation Logix 5000 Advanced, 1756 ControlLogix, 1756 GuardLogix, 1769 CompactLogix, 1769 Compact GuardLogix Process Control and Drives Instructions
...
Logix 5000 Advanced
Process Control and Drives
Instructions
1756 ControlLogix, 1756 GuardLogix, 1769 CompactLogix,
1769 Compact GuardLogix, 1789 SoftLogix, 5069
CompactLogix, Emulate 5570
Publication# 1756-RM006L-EN-P
Reference Manual |
Original Instructions |
Logix 5000 Advanced Process Control and Drives Instructions
Important User Information
Read this document and the documents listed in the additional resources section about installation, configuration, and operation of this equipment before you install, configure, operate, or maintain this product. Users are required to familiarize themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws, and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to be carried out by suitably trained personnel in accordance with applicable code of practice.
If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
IMPORTANT Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).
2 |
Publication 1756-RM006L-EN-P - September 2020 |
Summary of changes
This manual includes new and updated information. Use these reference tables to locate changed information.
Global changes
None for this release.
New or enhanced features
Subject |
Reason |
|
|
PlantPAx instructions on page 257 |
Added PlantPAx instructions. |
Publication 1756-RM006L-EN-P - September 2020 |
3 |
|
|
|
Instruction Locator |
|
|
|
|
|
|
|
Use this locator to find the applicable Logix5000 controllers instruction |
|||
|
manual for each instruction. |
|
|
|
|
|
|
|
|
|
Logix5000 Controllers General |
Logix5000 Controllers Advanced Process |
Logix5000 Controllers Motion Instructions |
|
|
Instructions Reference Manual 1756- |
Control and Drives and Equipment Phase |
Reference Manual MOTION-RM002 |
|
|
RM003 |
and Sequence Instructions Reference |
|
|
|
|
Manual 1756-RM006 |
|
|
|
Absolute Value (ABS) |
Alarm (ALM) |
Master Driven Coordinated Control (MDCC) |
|
|
|
|
|
|
|
Add (ADD) |
Attach to Equipment Phase (PATT) |
Motion Apply Axis Tuning (MAAT) |
|
|
Analog Alarm (ALMA) |
Attach to Equipment Sequence (SATT) |
Motion Apply Hookup Diagnostics (MAHD) |
|
|
Always False (AFI) |
Coordinated Control (CC) |
Motion Arm Output Cam (MAOC) |
|
|
Arc Cosine (ACS, ACOS) |
D Flip-Flop (DFF) |
Motion Arm Registration (MAR) |
|
|
|
|
|
|
|
Arc Sine (ASN, ASIN) |
Deadtime (DEDT) |
Motion Arm Watch (MAW) |
|
|
|
|
|
|
|
Arc Tangent (ATN, ATAN) |
Derivative (DERV) |
Motion Axis Fault Reset (MAFR) |
|
|
ASCII Chars in Buffer (ACB) |
Detach from Equipment Phase (PDET) |
Motion Axis Gear (MAG) |
|
|
|
|
|
|
|
ASCII Clear Buffer (ACL) |
Detach from Equipment Sequence (SDET) |
Motion Axis Home (MAH) |
|
|
ASCII Handshake Lines (AHL) |
Discrete 3-State Device (D3SD) |
Motion Axis Jog (MAJ) |
|
|
ASCII Read (ARD) |
Discrete 2-State Device (D2SD) |
Motion Axis Move (MAM) |
|
|
|
|
|
|
|
ASCII Read Line (ARL) |
Enhanced PID (PIDE) |
Motion Axis Position Cam (MAPC) |
|
|
ASCII Test for Buffer Line (ABL) |
Enhanced Select (ESEL) |
Motion Axis Stop (MAS) |
|
|
ASCII Write (AWT) |
Equipment Phase Clear Failure (PCLF) |
Motion Axis Time Cam (MATC) |
|
|
ASCII Write Append (AWA) |
Equipment Phase Command (PCMD) |
Motion Axis Shutdown (MASD) |
|
|
Bit Field Distribute (BTD) |
Equipment Phase External Request (PXRQ) |
Motion Axis Shutdown Reset (MASR) |
|
|
Bit Field Distribute with Target (BTDT) |
Equipment Phase Failure (PFL) |
Motion Calculate Cam Profile (MCCP) |
|
|
Bit Shift Left (BSL) |
Equipment Phase New Parameters (PRNP) |
Motion Coordinated Path Move (MCPM) |
|
|
|
|
|
|
|
Bit Shift Right (BSR) |
Equipment Phase Override Command |
Motion Calculate Slave Values (MCSV) |
|
|
|
(POVR) |
|
|
|
Bitwise And (AND) |
Equipment Phase Paused (PPD) |
Motion Coordinated Transform with Orientation |
|
|
|
|
(MCTO) |
|
|
Bitwise (NOT) |
Equipment Sequence Assign Sequence |
Motion Calculate Transform Position (MCTP) |
|
|
|
Identifier (SASI) |
|
|
|
Bitwise (OR) |
Equipment Sequence Clear Failure (SCLF) |
Motion Calculate Transform Position with |
|
|
|
|
Orientation (MCTPO) |
|
|
Boolean AND (BAND) |
Equipment Sequence command (SCMD) |
Motion Change Dynamics (MCD) |
|
|
Boolean Exclusive OR (BXOR) |
Equipment Sequence Override (SOVR) |
Motion Coordinated Change Dynamics (MCCD) |
|
|
Boolean NOT (BNOT) |
Function Generator (FGEN) |
Motion Coordinated Circular Move (MCCM) |
|
|
|
|
|
|
|
Boolean OR (BOR) |
High Pass Filter (HPF) |
Motion Coordinated Linear Move (MCLM) |
|
|
Break (BRK) |
High/Low Limit (HLL) |
Motion Coordinated Shutdown (MCSD) |
|
|
Breakpoints (BPT) |
HMI Button Control (HMIBC) |
Motion Coordinated Shutdown Reset (MCSR) |
|
|
Clear (CLR) |
Integrator (INTG) |
Motion Coordinated Stop (MCS) |
|
|
Compare (CMP) |
Internal Model Control (IMC) |
Motion Coordinated Transform (MCT) |
|
|
Convert to BCD (TOD) |
JK Flip-Flop (JKFF) |
Motion Direct Drive Off (MDF) |
|
|
Convert to Integer (FRD) |
Lead-Lag (LDLG) |
Motion Direct Drive On (MDO) |
|
|
Copy File (COP), Synchronous Copy File (CPS) |
Low Pass Filter (LPF) |
Motion Direct Start (MDS) |
|
|
|
|
|
|
|
Cosine (COS) |
Maximum Capture (MAXC) |
Motion Disarm Output Cam (MDOC) |
|
|
Compute (CPT) |
Minimum Capture (MINC) |
Motion Disarm Registration (MDR) |
|
|
|
|
|
|
|
Count down (CTD) |
Modular Multivariable Control (MMC) |
Motion Disarm Watch (MDW) |
|
|
Publication 1756-RM006L-EN-P - September 2020 |
5 |
|
|
Instruction Locator
|
Logix5000 Controllers General |
Logix5000 Controllers Advanced Process |
Logix5000 Controllers Motion Instructions |
|
Instructions Reference Manual 1756- |
Control and Drives and Equipment Phase |
Reference Manual MOTION-RM002 |
|
RM003 |
and Sequence Instructions Reference |
|
|
|
Manual 1756-RM006 |
|
|
Count up (CTU) |
Moving Average (MAVE) |
Motion Group Shutdown (MGSD) |
|
Count up/down CTUD |
Moving Standard Deviation (MSTD) |
Motion Group Shutdown Reset (MGSR) |
|
Data Transition (DTR) |
Multiplexer (MUX) |
Motion Group Stop (MGS) |
|
Degrees (DEG) |
Notch Filter (NTCH) |
Motion Group Strobe Position (MGSP) |
|
Diagnostic Detect (DDT) |
Phase State Complete (PSC) |
Motion Redefine Position (MRP) |
|
Digital Alarm (ALMD) |
Position Proportional (POSP) |
Motion Run Axis Tuning (MRAT) |
|
DINT To String (DTOS) |
Process Analog HART (PAH) |
Motion Run Hookup Diagnostics (MRHD) |
|
|
|
|
|
Divide (DIV) |
Process Analog Input (PAI) |
Motion Servo Off (MSF) |
|
End of Transition (EOT) |
Process Dual Sensor Analog Input (PAID) |
Motion Servo On (MSO) |
|
Equal to (EQU) |
Process Multi Sensor Analog Input (PAIM) |
|
|
|
|
|
|
File Arithmetic (FAL) |
Process Analog Output (PAO) |
|
|
File Bit Comparison (FBC) |
Process Boolean Logic (PBL) |
|
|
|
|
|
|
FIFO Load (FFL) |
Process Command Source (PCMDSRC) |
|
|
FIFO Unload (FFU) |
Process Deadband Controller (PDBC) |
|
|
|
|
|
|
File Average (AVE) |
Process Discrete Input (PDI) |
|
|
File Standard Deviation (STD) |
Process Discrete Output (PDO) |
|
|
File Fill (FLL) |
Process Dosing (PDOSE) |
|
|
File Sort (SRT) |
Process Analog Fanout (PFO) |
|
|
Find String (FIND) |
Process High or Low Selector (PHLS) |
|
|
For (FOR) |
Process Interlocks (PINTLK) |
|
|
File Search and Compare (FSC) |
Process Lead Lag Standby Motor Group |
|
|
|
(PLLS) |
|
|
Get System Value (GSV) and Set System |
Process Motor (PMTR) |
|
|
Value (SST) |
|
|
|
Greater Than or Equal to (GEQ) |
Process Permissives (PPERM) |
|
|
Greater than (GRT) |
Process Proportional + Integral + Derivative |
|
|
|
(PPID) |
|
|
Insert String (INSERT) |
Process Pressure/Temperature |
|
|
|
Compensated Flow (PPTC) |
|
|
Immediate Output (IOT) |
Process Restart Inhibit (PRI) |
|
|
Is Infinity (IsINF) |
Process Run Time and Start Counter (PRT) |
|
|
Is Not a Number (IsNAN) |
Process Tank Strapping Table (PTST) |
|
|
|
|
|
|
Jump to Label (JMP) and Label (LBL) |
Process Valve (PVLV) |
|
|
Jump to Subroutine (JSR), Subroutine (SBR), |
Process Valve Statistics (PVLVS) |
|
|
and Return (RET) |
|
|
|
Jump to External Routine (JXR) |
Proportional + Integral (PI) |
|
|
Less Than (LES) |
Pulse Multiplier (PMUL) |
|
|
Less Than or Equal to (LEQ) |
Ramp/Soak (RMPS) |
|
|
LIFO Load (LFL) |
Rate Limiter (RLIM) |
|
|
LIFO Unload (LFU) |
Reset Dominant (RESD) |
|
|
License Validation (LV) |
Scale (SCL) |
|
|
Limit (LIM) |
S-Curve (SCRV) |
|
|
Log Base (LOG) |
Second-Order Controller (SOC) |
|
|
Lower to Case (LOWER) |
Second-Order Lead Lag (LDL2) |
|
|
Masked Move (MVM) |
Select (SEL) |
|
|
Masked Move with Target (MVMT) |
Selected Negate (SNEG) |
|
6 |
Publication 1756-RM006L-EN-P - September 2020 |
|
|
|
|
|
Instruction Locator |
|
|
|
|
|
|
|
Logix5000 Controllers General |
Logix5000 Controllers Advanced Process |
Logix5000 Controllers Motion Instructions |
|
|
Instructions Reference Manual 1756- |
Control and Drives and Equipment Phase |
Reference Manual MOTION-RM002 |
|
|
RM003 |
and Sequence Instructions Reference |
|
|
|
|
Manual 1756-RM006 |
|
|
|
Master Control Reset (MCR) |
Selected Summer (SSUM) |
|
|
|
Masked Equal to (MEQ) |
Set Dominant (SETD) |
|
|
|
|
|
|
|
|
Message (MSG) |
Split Range Time Proportional (SRTP) |
|
|
|
Middle String (MID) |
Totalizer (TOT) |
|
|
|
Modulo (MOD) |
Up/Down Accumulator (UPDN) |
|
|
|
Move (MOV) |
|
|
|
|
|
|
|
|
|
Multiply (MUL) |
|
|
|
|
|
|
|
|
|
Natural Log (LN) |
|
|
|
|
|
|
|
|
|
Negate (NEG) |
|
|
|
|
Not Equal to (NEQ) |
|
|
|
|
|
|
|
|
|
No Operation (NOP) |
|
|
|
|
One Shot (ONS) |
|
|
|
|
|
|
|
|
|
One Shot Falling (OSF) |
|
|
|
|
One Shot Falling with Input (OSFI) |
|
|
|
|
|
|
|
|
|
One Shot Rising (OSR) |
|
|
|
|
|
|
|
|
|
One Shot Rising with Input (OSRI) |
|
|
|
|
Output Energize (OTE) |
|
|
|
|
|
|
|
|
|
Output Latch (OTL) |
|
|
|
|
Output Unlatch (OTU) |
|
|
|
|
|
|
|
|
|
Proportional Integral Derivative (PID) |
|
|
|
|
Radian (RAD) |
|
|
|
|
|
|
|
|
|
Real to String (RTOS) |
|
|
|
|
Reset (RES) |
|
|
|
|
|
|
|
|
|
Reset SFC (SFR) |
|
|
|
|
Return (RET) |
|
|
|
|
|
|
|
|
|
Retentive Timer On (RTO) |
|
|
|
|
Retentive Timer On with Reset (RTOR) |
|
|
|
|
Pause SFC (SFP) |
|
|
|
|
Size In Elements (SIZE) |
|
|
|
|
Sequencer Input (SQI) |
|
|
|
|
Sequencer Load (SQL) |
|
|
|
|
Sequencer Output (SQO) |
|
|
|
|
|
|
|
|
|
Sine (SIN) |
|
|
|
|
Square Roost (SQR/SQRT) |
|
|
|
|
|
|
|
|
|
String Concatenate (CONCAT) |
|
|
|
|
String Delete (DELETE) |
|
|
|
|
|
|
|
|
|
String to DINT (STOD) |
|
|
|
|
String to REAL (STOR) |
|
|
|
|
|
|
|
|
|
Swap Byte (SWPB) |
|
|
|
|
|
|
|
|
|
Subtract (SUB) |
|
|
|
|
|
|
|
|
|
Tangent (TAN) |
|
|
|
|
Timer Off Delay (TOF) |
|
|
|
|
|
|
|
|
|
Timer Off Delay with Reset (TOFR) |
|
|
|
|
Timer On Delay (TON) |
|
|
|
|
|
|
|
|
|
Publication 1756-RM006L-EN-P - September 2020 |
7 |
|
|
Instruction Locator
Logix5000 Controllers General |
Logix5000 Controllers Advanced Process |
Logix5000 Controllers Motion Instructions |
Instructions Reference Manual 1756- |
Control and Drives and Equipment Phase |
Reference Manual MOTION-RM002 |
RM003 |
and Sequence Instructions Reference |
|
|
Manual 1756-RM006 |
|
Timer On Delay with Reset (TONR) |
|
|
Temporary End (TND) |
|
|
|
|
|
Tracepoints (TPT) |
|
|
|
|
|
Trigger Event Task (EVENT) |
|
|
|
|
|
Truncate (TRN) |
|
|
|
|
|
Unknown Instruction (UNK) |
|
|
Upper Case (UPPER) |
|
|
|
|
|
User Interrupt Disable (UID)/User Interrupt |
|
|
Enable (UIE) |
|
|
X to the Power of Y (XPY) |
|
|
Examine if Closed (XIC) |
|
|
|
|
|
Examine If Open (XIO) |
|
|
Bitwise Exclusive (XOR) |
|
|
|
|
|
8 |
Publication 1756-RM006L-EN-P - September 2020 |
Table of Contents
Summary of changes
Instruction Locator
Preface
Process Control Instructions
Studio 5000 environment ......................................................................... |
15 |
Additional resources.................................................................................. |
15 |
Purpose of this manual.............................................................................. |
16 |
Legal Notices .............................................................................................. |
16 |
Chapter 1 |
|
Process Control Instructions .................................................................... |
17 |
Alarm (ALM) ............................................................................................... |
18 |
Discrete 3-State Device (D3SD) ................................................................ |
24 |
Discrete 2-State Device (D2SD)................................................................ |
38 |
Deadtime (DEDT)...................................................................................... |
48 |
Function Generator (FGEN) ...................................................................... |
54 |
Lead-Lag (LDLG)........................................................................................ |
60 |
Enhanced PID (PIDE) ................................................................................ |
65 |
Position Proportional (POSP)................................................................... |
99 |
Ramp/Soak (RMPS).................................................................................. |
107 |
Scale (SCL) ................................................................................................ |
122 |
Split Range Time Proportional (SRTP)................................................... |
126 |
Totalizer (TOT) ......................................................................................... |
134 |
Coordinated Control (CC) ....................................................................... |
143 |
CC Function Block Configuration .................................................... |
180 |
CC Function Block Model Initialization........................................... |
181 |
CC Function Block Tuning ................................................................ |
181 |
CC Function Block Tuning Errors .................................................... |
182 |
CC Function Block Tuning Procedure.............................................. |
182 |
Internal Model Control (IMC) ................................................................. |
182 |
IMC Function Block Configuration................................................. |
200 |
IMC Function Block Model Initialization ........................................ |
201 |
IMC Function Block Tuning.............................................................. |
201 |
IMC Function Block Tuning Errors................................................. |
202 |
IMC Function Block Tuning Procedure .......................................... |
202 |
Modular Multivariable Control (MMC) ................................................. |
203 |
MMC Function Block Configuration................................................ |
241 |
MMC Function Block Model Initialization ...................................... |
243 |
MMC Function Block Tuning............................................................ |
243 |
Use an MMC Function Block for Splitter Control ........................... |
244 |
MMC Function Block Tuning Errors................................................ |
244 |
MMC Function Block Tuning Procedure ......................................... |
244 |
Current SP................................................................................................. |
245 |
Use the Coordinated Control Function Block to Control ............... |
245 |
CV High/Low Limiting............................................................................. |
247 |
Publication 1756-RM006L-EN-P - September 2020 |
9 |
Table of Contents |
|
|
|
CV Percent Limiting................................................................................ |
248 |
|
CV Rate-of-Change Limiting.................................................................. |
249 |
|
CV Windup Limiting............................................................................... |
249 |
|
Execution ................................................................................................. |
250 |
|
Switch Between Program Control and Operator Control ............. |
250 |
|
Operating Modes................................................................................ |
251 |
|
Convert the PV and SP Values to Percent ....................................... |
252 |
|
Primary Loop Control ....................................................................... |
252 |
|
Processing Faults ............................................................................... |
254 |
|
Select the Control Variable................................................................ |
254 |
|
Update the CVOper and CVProg Values .......................................... |
255 |
|
Select the Setpoint ............................................................................. |
255 |
|
SP High/Low Limiting ....................................................................... |
255 |
|
Chapter 2 |
|
PlantPAx |
PlantPAx instructions.............................................................................. |
257 |
|
Process Analog HART (PAH)................................................................... |
259 |
|
Process Analog Input (PAI)...................................................................... |
274 |
|
Process Dual Sensor Analog Input (PAID) ............................................ |
304 |
|
Process Multi Sensor Analog Input (PAIM) ........................................... |
321 |
|
Process Analog Output (PAO).................................................................. |
344 |
|
Process Analog Output feedback processing ................................... |
377 |
|
Process Boolean Logic (PBL).................................................................... |
387 |
|
Process Command Source (PCMDSRC)................................................ |
403 |
|
Process Command Source operating model.................................... |
413 |
|
Process Deadband Controller (PDBC) .................................................... |
414 |
|
Process Discrete Input (PDI)................................................................... |
432 |
|
Process Discrete Output (PDO).............................................................. |
448 |
|
Process Dosing (PDOSE) ......................................................................... |
474 |
|
Process Analog Fanout (PFO) ................................................................. |
509 |
|
Process High or Low Selector (PHLS)..................................................... |
521 |
|
Process Interlocks (PINTLK) ................................................................... |
531 |
|
Process Lead Lag Standby Motor Group (PLLS) .................................... |
542 |
|
Motor Sort Algorithm for Process Lead Lag Standby Motor Group |
|
|
(PLLS) instructions ............................................................................ |
572 |
|
Process Motor (PMTR) ............................................................................. |
574 |
|
Process Motor (PMTR) Command Source ...................................... |
609 |
|
Process Permissives (PPERM)................................................................. |
611 |
|
Process Proportional + Integral + Derivative (PPID)............................ |
620 |
|
Process Pressure/Temperature Compensated Flow (PPTC)................ |
707 |
|
Process Restart Inhibit (PRI)................................................................... |
715 |
|
Process Run Time and Start Counter (PRT)........................................... |
722 |
10 |
Publication 1756-RM006L-EN-P - September 2020 |
|
Table of Contents
Drives
Filter
Select_Limit Instructions
Statistical Instructions
Process Tank Strapping Table (PTST)..................................................... |
729 |
Process Valve (PVLV)................................................................................ |
737 |
Process Valve (PVLV) Command Source.......................................... |
767 |
Process Valve Statistics (PVLVS)............................................................. |
769 |
Process Variable Speed Drive (PVSD)..................................................... |
781 |
Process Variable Speed Drive (PVSD) Command Source............... |
816 |
Chapter 3 |
|
Drives Instructions................................................................................. |
823 |
Integrator (INTG) ................................................................................... |
823 |
Proportional + Integral (PI) .................................................................... |
830 |
Pulse Multiplier (PMUL) ......................................................................... |
840 |
S-Curve (SCRV) ....................................................................................... |
848 |
Second-Order Controller (SOC).............................................................. |
856 |
Up/Down Accumulator (UPDN).............................................................. |
865 |
HMI Button Control (HMIBC) ............................................................... |
870 |
Chapter 4 |
|
Filter Instructions.................................................................................... |
875 |
Derivative (DERV) ................................................................................... |
875 |
High Pass Filter (HPF) ............................................................................. |
879 |
Low Pass Filter (LPF) ............................................................................... |
885 |
Notch Filter (NTCH)................................................................................ |
890 |
Second-Order Lead Lag (LDL2) .............................................................. |
896 |
Chapter 5 |
|
Select/Limit Instructions ....................................................................... |
903 |
Enhanced Select (ESEL) ......................................................................... |
903 |
High/Low Limit (HLL) ............................................................................. |
912 |
Multiplexer (MUX) ................................................................................... |
916 |
Rate Limiter (RLIM) ................................................................................. |
919 |
Select (SEL) ............................................................................................... |
923 |
Selected Negate (SNEG) ......................................................................... |
926 |
Selected Summer (SSUM) ...................................................................... |
930 |
Chapter 6 |
|
Statistical Instructions ............................................................................ |
935 |
Moving Average (MAVE) ......................................................................... |
935 |
Maximum Capture (MAXC) ................................................................... |
942 |
Minimum Capture (MINC) ..................................................................... |
946 |
Moving Standard Deviation (MSTD)...................................................... |
949 |
Publication 1756-RM006L-EN-P - September 2020 |
11 |
Table of Contents |
|
|
|
Chapter 7 |
|
Logical and Move |
Logical and Move Instructions ............................................................... |
955 |
|
D Flip-Flop (DFF) ..................................................................................... |
955 |
|
JK Flip-Flop (JKFF).................................................................................... |
959 |
|
Reset Dominant (RESD) ......................................................................... |
962 |
|
Set Dominant (SETD) .............................................................................. |
965 |
|
Chapter 8 |
|
Equipment Phase Instructions |
Equipment Phase Instructions............................................................... |
969 |
|
Attach to Equipment Phase (PATT) ....................................................... |
970 |
|
Detach from Equipment Phase (PDET).................................................. |
975 |
|
Equipment Phase Clear Failure (PCLF) .................................................. |
978 |
|
Equipment Phase Command (PCMD)................................................... |
980 |
|
Equipment Phase External Request (PXRQ) ......................................... |
987 |
|
Equipment Phase Failure (PFL)............................................................... |
997 |
|
Equipment Phase New Parameters (PRNP)......................................... |
1001 |
|
Equipment Phase Override Command (POVR).................................. |
1004 |
|
Equipment Phase Paused (PPD) .......................................................... |
1008 |
|
Phase State Complete (PSC) .................................................................. |
1012 |
|
Chapter 9 |
|
Equipment Sequence |
Equipment Sequence instructions....................................................... |
1019 |
|
Attach to Equipment Sequence (SATT)................................................ |
1019 |
|
Detach from Equipment Sequence (SDET) ......................................... |
1021 |
|
Equipment Sequence Assign Sequence Identifier (SASI)................... |
1023 |
|
Equipment Sequence Clear Failure (SCLF).......................................... |
1025 |
|
Equipment Sequence command (SCMD) ............................................ |
1027 |
|
Equipment Sequence Diagram instructions ....................................... |
1031 |
|
Equipment Sequence Override (SOVR)................................................ |
1031 |
|
Guidelines for SATT instructions.......................................................... |
1033 |
|
Guidelines for SCMD instructions ....................................................... |
1034 |
|
Guidelines for SOVR instructions......................................................... |
1035 |
|
Result codes for SATT instructions....................................................... |
1036 |
|
Result codes for SCLF instructions....................................................... |
1036 |
|
Result codes for SCMD instructions..................................................... |
1037 |
|
Result codes for SOVR instructions...................................................... |
1038 |
|
SASI instruction examples .................................................................... |
1038 |
|
SATT instruction examples.................................................................... |
1039 |
|
SCLF instruction examples................................................................... |
1040 |
|
SCMD instruction examples ................................................................ |
1040 |
|
SDET instruction examples................................................................... |
1041 |
|
SOVR instruction examples .................................................................. |
1041 |
12 |
Publication 1756-RM006L-EN-P - September 2020 |
|
|
|
Table of Contents |
|
When should I use an SOVR instruction instead of an SCMD |
|
|
instruction?............................................................................................. |
1042 |
|
Chapter 10 |
|
Function Block Attributes |
Choose the Function Block Elements................................................... |
1043 |
|
Latching Data ......................................................................................... |
1044 |
|
Function Block Responses to Overflow Conditions ............................ |
1045 |
|
Order of Execution................................................................................. |
1046 |
|
Timing Modes......................................................................................... |
1050 |
|
Program/Operator Control.................................................................... |
1052 |
|
Function Block States............................................................................. |
1055 |
|
Chapter 11 |
|
Structured Text Programming |
Structured Text Syntax.......................................................................... |
1057 |
|
Structured Text Components: Comments........................................... |
1058 |
|
Structured Text Components: Assignments........................................ |
1059 |
|
Specify a non-retentive assignment .............................................. |
1060 |
|
Assign an ASCII character to a string data member ..................... |
1061 |
|
Structured Text Components: Expressions ......................................... |
1061 |
|
Use arithmetic operators and functions ........................................ |
1063 |
|
Use bitwise operators ...................................................................... |
1064 |
|
Use logical operators........................................................................ |
1064 |
|
Use relational operators .................................................................. |
1065 |
|
Structured Text Components: Instructions......................................... |
1066 |
|
Structured Text Components: Constructs ........................................... |
1067 |
|
Character string literals ......................................................................... |
1068 |
|
String Types...................................................................................... |
1069 |
|
CASE_OF................................................................................................. |
1069 |
|
FOR_DO .................................................................................................. |
1071 |
|
IF_THEN ................................................................................................. |
1074 |
|
REPEAT_UNTIL ..................................................................................... |
1077 |
|
WHILE_DO............................................................................................ |
1080 |
|
Structured Text Attributes..................................................................... |
1082 |
Common Attributes for Advanced Process Control and Drives Instructions
Chapter 12 |
|
Common Attributes............................................................................... |
1083 |
Math Status Flags................................................................................... |
1083 |
Immediate values................................................................................... |
1085 |
Data Conversions................................................................................... |
1086 |
Elementary data types............................................................................ |
1089 |
Floating Point Values ............................................................................. |
1092 |
Index Through Arrays ............................................................................ |
1094 |
Publication 1756-RM006L-EN-P - September 2020 |
13 |
Table of Contents
Bit Addressing ........................................................................................ |
1094 |
Function Block Faceplate Controls ....................................................... |
1095 |
Faceplate Control Properties Dialog - General Tab ............................. |
1097 |
Faceplate Control Properties Dialog - Display Tab.............................. |
1097 |
Faceplate Control Properties Dialog - Font Tab................................... |
1098 |
Faceplate Control Properties Dialog - LocaleTab................................. |
1100 |
ASCII Character Codes ........................................................................... |
1101 |
ASCII character codes............................................................................. |
1101 |
Index
14 |
Publication 1756-RM006L-EN-P - September 2020 |
Preface
Studio 5000 environment
Additional resources
This manual provides a programmer with details about the available General, Motion, Process, and Drives instruction set for a Logix-based controller.
If you design, program, or troubleshoot safety applications that use GuardLogix controllers, refer to the GuardLogix Safety Application Instruction Set Safety Reference Manual, publication 1756-RM095.
This manual is one of a set of related manuals that show common procedures for programming and operating Logix 5000 controllers.
For a complete list of common procedures manuals, refer to the Logix 5000 Controllers Common Procedures Programming Manual, publication 1756PM001.
The term Logix 5000 controller refers to any controller based on the Logix 5000 operating system.
The Studio 5000 Automation Engineering & Design Environment® combines engineering and design elements into a common environment. The first element is the Studio 5000 Logix Designer® application. The Logix Designer application is the rebranding of RSLogix 5000® software and will continue to be the product to program Logix 5000™ controllers for discrete, process, batch, motion, safety, and drive-based solutions.
The Studio 5000® environment is the foundation for the future of
Rockwell Automation® engineering design tools and capabilities. The Studio 5000 environment is the one place for design engineers to develop all elements of their control system.
These documents contain additional information concerning related Rockwell Automation products.
Publication 1756-RM006L-EN-P - September 2020 |
15 |
Preface
Purpose of this manual
Legal Notices
Resource |
Description |
|
|
Industrial Automation Wiring and Grounding |
Provides general guidelines for installing a Rockwell |
Guidelines, publication 1770-4.1 |
Automation industrial system. |
|
|
Product Certifications webpage, available at |
Provides declarations of conformity, certificates, |
http://ab.rockwellautomation.com |
and other certification details. |
View or download publications at http://www.rockwellautomation.com/literature. To order paper copies of technical documentation, contact the local Rockwell Automation distributor or sales representative.
This manual provides a programmer with details about each available instruction for a Logix-based controller. This manual also gives you guidance and examples to use equipment phase instructions to transition to different state, handle faults, set up break points, and so forth.
Rockwell Automation publishes legal notices, such as privacy policies, license agreements, trademark disclosures, and other terms and conditions on the Legal Notices page of the Rockwell Automation website.
End User License Agreement (EULA)
You can view the Rockwell Automation End-User License Agreement ("EULA") by opening the License.rtf file located in your product's install folder on your hard drive.
Open Source Licenses
The software included in this product contains copyrighted software that is licensed under one or more open source licenses. Copies of those licenses are included with the software. Corresponding Source code for open source packages included in this product are located at their respective web site(s).
Alternately, obtain complete Corresponding Source code by contacting Rockwell Automation via the Contact form on the Rockwell Automation website: http://www.rockwellautomation.com/global/aboutus/contact/contact.page
Please include "Open Source" as part of the request text.
A full list of all open source software used in this product and their corresponding licenses can be found in the OPENSOURCE folder. The default
installed location of these licenses is C:\Program Files (x86)\Common Files\Rockwell\Help\FactoryTalk Services Platform\Release
Notes\OPENSOURCE\index.htm.
16 |
Publication 1756-RM006L-EN-P - September 2020 |
Chapter 1
Process Control
Instructions
Process Control Instructions
The Process Control instructions include these instructions:
Available Instructions
Ladder Diagram
Not available
Function Block and Structured Text
ALM |
|
SCL |
PIDE |
|
RMPS |
|
POSP |
|
SRTP |
LDLG |
|
FGEN |
|
|
|
|
|
|
|
|
|
|
|
|
|||||
TOT |
|
DEDT |
D2SD |
|
D3SD |
|
IMC |
|
|
CC |
MMC |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|||
If you want to |
|
|
|
|
|
|
|
|
Use this instruction |
|
|
|||
Provide alarming for any analog signal. |
|
|
|
|
|
ALM |
|
|
|
|
||||
|
|
|
|
|
|
|
||||||||
Control discrete devices, such as solenoid valves, pumps, and |
|
D2SD |
|
|
|
|
||||||||
motors, that have only two possible states (e.g., on/off, |
|
|
|
|
|
|
||||||||
open/closed, etc.). |
|
|
|
|
|
|
|
|
|
|
|
|
||
Control discrete devices, such as high/low/off feeders that have |
|
D3SD |
|
|
|
|
||||||||
three possible states (e.g., fast/slow/off, forward/stop/reverse, |
|
|
|
|
|
|
||||||||
etc.). |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perform a delay of a single input. You select the amount of |
|
DEDT |
|
|
|
|
||||||||
deadtime delay. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Convert an input based on a piece-wise linear function. |
|
FGEN |
|
|
|
|
||||||||
Provide a phase lead-lag compensation for an input signal. |
|
LDLG |
|
|
|
|
||||||||
Regulate an analog output to maintain a process variable at a |
|
PIDE |
|
|
|
|
||||||||
certain setpoint, using a PID algorithm. |
|
|
|
|
|
|
|
|
|
|
||||
Raise/lower or open/close a device, such as a motor-operated |
|
POSP |
|
|
|
|
||||||||
valve, by pulsing open or close contacts. |
|
|
|
|
|
|
|
|
|
|
||||
Provide for alternating ramp and soak periods to follow a |
|
RMPS |
|
|
|
|
||||||||
temperature profile. |
|
|
|
|
|
|
|
|
|
|
|
|
||
Convert an unscaled input value to a floating point value in |
|
SCL |
|
|
|
|
||||||||
engineering units. |
|
|
|
|
|
|
|
|
|
|
|
|
||
Take the 0-100% output of a PID loop and drive heating and |
|
SRTP |
|
|
|
|
||||||||
cooling digital output contacts with a periodic pulse. |
|
|
|
|
|
|
|
|
||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Publication 1756-RM006L-EN-P - September 2020 |
17 |
Chapter 1 |
Process Control Instructions |
Provide a time-scaled accumulation of an analog input value, such |
TOT |
as a volumetric flow. |
|
Control a single process variable by maintaining a single controller |
IMC |
output. |
|
Control a single process variable by manipulating as many as three |
CC |
different control variables. |
|
Control two process variables to their setpoints using up to three |
MMC |
control variables. |
|
See also
Alarm (ALM)
Filter Instructions on page 875
Logical and Move Instructions on page 955
Drives Instructions on page 823
Select/Limit Instructions on page 903
Statistical Instructions on page 935
This information applies to the CompactLogix 5370, ControlLogix 5570, Compact GuardLogix 5370, GuardLogix 5570, Compact GuardLogix 5380, CompactLogix 5380, CompactLogix 5480, ControlLogix 5580, and GuardLogix 5580 controllers.
The ALM instruction provides alarming for any analog signal.
Available Languages
Ladder Diagram
This instruction is not available in ladder diagram logic.
18 |
Publication 1756-RM006L-EN-P - September 2020 |
Chapter 1 |
Process Control Instructions |
Function Block
Structured Text
ALM(ALM_tag)
Operands
Function Block
Operand |
Type |
Format |
Description |
|
|
|
|
ALM tag |
ALARM |
structure |
ALM structure |
Structured Text
Operand |
Type |
Format |
Description |
ALM tag |
ALARM |
structure |
ALM structure |
See Structured Text Syntax for more information on the syntax of expressions within structured text.
ALARM Structure
Input Parameter |
Data Type |
Description |
EnableIn |
BOOL |
Enable input. If false, the instruction does not execute and |
|
|
outputs are not updated. |
|
|
Default is true. |
In |
REAL |
The analog signal input. |
|
|
Valid = any float |
|
|
Default = 0.0 |
HHLimit |
REAL |
The high-high alarm limit for the input. |
|
|
Valid = any real value |
|
|
Default = maximum positive value |
Publication 1756-RM006L-EN-P - September 2020 |
19 |
Chapter 1 |
Process Control Instructions |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Input Parameter |
Data Type |
Description |
|
|
|
|
HLimit |
REAL |
The high alarm limit for the input. |
|
|
|
|
|
|
Valid = any real value |
|
|
|
|
|
|
Default = maximum positive value |
|
|
|
|
LLimit |
REAL |
The low alarm limit for the input. |
|
|
|
|
|
|
Valid = any real value |
|
|
|
|
|
|
Default = maximum negative value |
|
|
|
|
LLLimit |
REAL |
The low-low alarm limit for the input. |
|
|
|
|
|
|
Valid = any real value |
|
|
|
|
|
|
Default = maximum negative value |
|
|
|
|
Deadband |
REAL |
The alarm deadband for the high-high to low-low limits |
|
|
|
|
|
|
Valid = any real value |
0.0 |
|
|
|
|
|
Default = 0.0 |
|
|
|
|
ROCPosLimit |
REAL |
The rate-of-change alarm limit in units per second for a |
|
|
|
|
|
|
positive (increasing) change in the input. Set ROCPosLimit = |
|
|
|
|
|
|
0 to disable ROC positive alarming. If invalid, the instruction |
|
|
|
|
|
|
assumes a value of 0.0 and sets the appropriate bit in |
|
|
|
|
|
|
Status. |
|
|
|
|
|
|
Valid = any real value |
0.0 |
|
|
|
|
|
Default = 0.0 |
|
|
|
|
ROCNegLimit |
REAL |
The rate-of-change alarm limit in units per second for a |
|
|
|
|
|
|
negative (decreasing) change in the input. Set ROCNegLimit |
|
|
|
|
|
|
= 0 to disable ROC negative alarming. If invalid, the |
|
|
|
|
|
|
instruction assumes a value of 0.0 and sets the appropriate |
|
|
|
|
|
|
bit in Status. |
|
|
|
|
|
|
Valid = any real value |
0.0 |
|
|
|
|
|
Default = 0.0 |
|
|
|
|
ROCPeriod |
REAL |
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 re- |
|
|
|
|
|
|
calculated. Instead of an enable bit like other conditions in |
|
|
|
|
|
|
the analog alarm, the rate-of-change detection is enabled by |
|
|
|
|
|
|
putting any non-zero value in the ROCPeriod. |
|
|
|
|
|
|
Valid = 0.0 to 32767.0 |
|
|
|
|
|
|
Default = 0.0. |
|
|
|
Output Parameter |
Data Type |
Description |
|
EnableOut |
BOOL |
Indicates if instruction is enabled. Cleared to false if ROC |
|
|
|
overflows. |
|
HHAlarm |
BOOL |
The high-high alarm indicator. |
|
|
|
Default = false |
|
HAlarm |
BOOL |
The high alarm indicator. |
|
|
|
Default = false |
|
LAlarm |
BOOL |
The low alarm indicator. |
|
|
|
Default = false |
|
LLAlarm |
BOOL |
The low-low alarm indicator. |
|
|
|
Default = false |
|
ROCPosAlarm |
BOOL |
The rate-of-change positive alarm indicator. |
|
|
|
Default = false |
|
ROCNegAlarm |
BOOL |
The rate-of-change negative alarm indicator. |
|
|
|
Default = false |
20 |
Publication 1756-RM006L-EN-P - September 2020 |
||
|
|
|
Chapter 1 |
Process Control Instructions |
|
|
|
|
|
|
|
|
Output Parameter |
Data Type |
Description |
|
|
|
ROC |
REAL |
The rate-of-change output. |
|
|
|
Status |
DINT |
Status of the function block. |
|
|
|
InstructFault (Status.0) |
BOOL |
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. |
|
|
|
DeadbandInv (Status.1) |
BOOL |
Invalid Deadband value. |
|
|
|
ROCPosLimitInv (Status.2) |
BOOL |
Invalid ROCPosLimit value. |
|
|
|
ROCNegLimitInv (Status.3) |
BOOL |
Invalid ROCNegLimit value. |
|
|
|
ROCPeriodInv (Status.4) |
BOOL |
Invalid ROCPeriod value. |
|
|
Description
The ALM instruction provides alarm indicators for high-high, high, low, lowlow, rate-of-change positive, and rate-of-change negative. An alarm deadband is available for the high-high to low-low alarms. A user-defined period for performing rate-of-change alarming is also available.
High-high to Low-low Alarm
The high-high and low-low alarm algorithms compare the input to the alarm limit and the alarm limit plus or minus the deadband.
Rate-of-change Alarm
The rate-of-change (ROC) alarm compares the change of the input over the ROCPeriod to the rate-of-change limits. The ROCPeriod provides a type of deadband for the rate-of-change alarm. For example, define an ROC alarm limit of 2OF/second with a period of execution of 100 ms. If you use an analog input module with a resolution of 1OF, every time the input value changes, an ROC alarm is generated because the instruction calculates an effective rate of 10°F/second. However, enter an ROCPeriod of 1 sec and the instruction only generates an alarm if the rate truly exceeds the 2OF/second limit.
The ROC alarm calculates the rate-of-change as:
Publication 1756-RM006L-EN-P - September 2020 |
21 |
Chapter 1 |
Process Control Instructions |
The instruction performs this calculation when the ROCPeriod expires. Once the instruction calculates the ROC, it determines alarms as:
Monitoring the ALM Instruction
There is an operator faceplate available for the ALM instruction.
Affects Math Status Flags
No
Major/Minor Faults
None specific to this instruction. See Common Attributes for operand-related faults.
Execution
Function Block
Condition/State |
Action Taken |
Prescan |
Rung-condition-in bits are cleared to false. |
Rung-condition-in is false |
Rung-condition-in bits are cleared to false. |
Rung-condition-in is true |
Rung-condition-in bits are set to true. |
|
The instruction executes. |
|
|
Postscan |
Rung-condition-in bits are cleared to false. |
22 |
Publication 1756-RM006L-EN-P - September 2020 |
Chapter 1 Process Control Instructions
Structured Text
Condition/State |
Action Taken |
Prescan |
See Prescan in the Function Block table. |
Normal Execution |
See Rung-condition-in is true in the Function Block table. |
Postscan |
See Postscan in the Function Block table. |
Example
The ALM instruction is typically used either with analog input modules (such as 1771 I/O modules) that do not support on-board alarming, or to generate alarms on a calculated variable. In this example, an analog input from a 1771IFE module is first scaled to engineering units using the SCL instruction. The Out of the SCL instruction is an input to the ALM instruction to determine whether to set an alarm. The resulting alarm output parameters could then be used in your program and/or viewed on an operator interface display.
Function Block
Structured Text
SCL_01.IN := Input0From1771IFE;
SCL(SCL_01);
ALM_01.IN := SCL_01.Out;
ALM(ALM_01);
See also
Common Attributes on page 1083
Structured Text Syntax on page 1057
Function Block Faceplate Controls on page 1095
Publication 1756-RM006L-EN-P - September 2020 |
23 |
Chapter 1 |
Process Control Instructions |
Discrete 3-State Device (D3SD)
24
This information applies to the CompactLogix 5370, ControlLogix 5570, Compact GuardLogix 5370, GuardLogix 5570, Compact GuardLogix 5380, CompactLogix 5380, CompactLogix 5480, ControlLogix 5580, and GuardLogix 5580 controllers.
The D3SD instruction controls a discrete device having three possible states, such as fast/slow/off or forward/stop/reverse.
Available Languages
Ladder Diagram
This instruction is not available in ladder diagram logic.
Function Block
Structured Text
D3SD(D3SD_tag)
Publication 1756-RM006L-EN-P - September 2020
|
|
|
Chapter 1 |
Process Control Instructions |
||
Operands |
|
|
|
|
|
|
Structured Text |
|
|
|
|
||
|
|
|
|
|
|
|
|
Operand |
Type |
Format |
Description |
|
|
|
D3SD tag |
DISCRETE_3STATE |
structure |
D3SD structure |
|
|
See Structured Text Syntax for more information on the syntax of expressions within structured text.
Function Block
Operand |
Type |
Format |
Description |
D3SD tag |
DISCRETE_3STATE |
structure |
D3SD structure |
DISCRETE_3STATE Structure
Input Parameter |
Data Type |
Description |
EnableIn |
BOOL |
Enable input. If false, the instruction |
|
|
does not execute and outputs are not |
|
|
updated. |
|
|
Default is true. |
Prog0Command |
BOOL |
Program state 0 command. This input |
|
|
determines the device state when the |
|
|
device is in Program control. If true, |
|
|
the device is commanded to the 0 |
|
|
state. |
|
|
Default is false. |
Prog1Command |
BOOL |
Program state 1 command. This input |
|
|
determines the device state when the |
|
|
device is in Program control. If true, |
|
|
the device is commanded to the 1 |
|
|
state. |
|
|
Default is false. |
Prog2Command |
BOOL |
Program state 2 command. This input |
|
|
determines the device state when the |
|
|
device is in Program control. If true, |
|
|
the device is commanded to the 2 |
|
|
state. |
|
|
Default is false. |
Oper0Req |
BOOL |
Operator state 0 request. Set to true by |
|
|
the operator interface to place the |
|
|
device into the 0 state when the |
|
|
device is in Operator control. |
|
|
Default is false. |
Oper1Req |
BOOL |
Operator state 1 request. Set true by |
|
|
the operator interface to place the |
|
|
device into the 1 state when the device |
|
|
is in Operator control. |
|
|
Default is false. |
Publication 1756-RM006L-EN-P - September 2020 |
25 |
Chapter 1 |
Process Control Instructions |
Input Parameter |
Data Type |
Description |
Oper2Req |
BOOL |
Operator state 2 request. Set to true by |
|
|
the operator interface to place the |
|
|
device into the 2 state when the device |
|
|
is in Operator control. |
|
|
Default is false. |
State0Perm |
BOOL |
State 0 permissive. Unless in Hand or |
|
|
Override mode, this input must be true |
|
|
for the device to enter the 0 state. This |
|
|
input has no effect if the device is |
|
|
already in the 0 state. |
|
|
Default is true. |
State1Perm |
BOOL |
State 1 permissive. Unless in Hand or |
|
|
Override mode, this input must be true |
|
|
for the device to enter the 1 state. This |
|
|
input has no effect if the device is |
|
|
already in the 1 state. |
|
|
Default is true. |
State2Perm |
BOOL |
State 2 permissive. Unless in Hand or |
|
|
Override mode, this input must be true |
|
|
for the device to enter the 2 state. This |
|
|
input has no effect if the device is |
|
|
already in the 2 state. |
|
|
Default is true. |
FB0 |
BOOL |
The first feedback input available to |
|
|
the instruction. |
|
|
Default is false. |
FB1 |
BOOL |
The second feedback input available to |
|
|
the instruction. |
|
|
Default is false. |
FB2 |
BOOL |
The third feedback input available to |
|
|
the instruction. |
|
|
Default is false. |
FB3 |
BOOL |
The fourth feedback input available to |
|
|
the instruction. |
|
|
Default is false. |
HandFB0 |
BOOL |
Hand feedback state 0. This input from |
|
|
a field hand/off/auto station shows |
|
|
the requested state of the field device. |
|
|
True indicates the field device is being |
|
|
requested to enter the 0 state; false |
|
|
indicates the field device is being |
|
|
requested to enter some other state. |
|
|
Default is false. |
HandFB1 |
BOOL |
Hand feedback state 1. This input from |
|
|
a field hand/off/auto station shows |
|
|
the requested state of the field device. |
|
|
True indicates the field device is being |
|
|
requested to enter the 1 state; false |
|
|
indicates the field device is being |
|
|
requested to enter some other state. |
|
|
Default is false. |
26 |
Publication 1756-RM006L-EN-P - September 2020 |
|
|
|
Chapter 1 |
Process Control Instructions |
|
|
|
|
|
|
|
|
Input Parameter |
Data Type |
Description |
|
|
|
HandFB2 |
BOOL |
Hand feedback state 2. This input from |
|
|
|
|
|
a field hand/off/auto station shows |
|
|
|
|
|
the requested state of the field device. |
|
|
|
|
|
True indicates the field device is being |
|
|
|
|
|
requested to enter the 2 state; false |
|
|
|
|
|
indicates the field device is being |
|
|
|
|
|
requested to enter some other state. |
|
|
|
|
|
Default is false. |
|
|
|
FaultTime |
REAL |
Fault time value. Configure the value in |
|
|
|
|
|
seconds of the time to allow the device |
|
|
|
|
|
to reach a newly commanded state. |
|
|
|
|
|
Set FaultTime = 0 to disable the fault |
|
|
|
|
|
timer. If this value is invalid, the |
|
|
|
|
|
instruction assumes a value of zero |
|
|
|
|
|
and sets the appropriate bit in Status. |
|
|
|
|
|
Valid = any float |
0.0 |
|
|
|
|
Default = 0.0 |
|
|
|
FaultAlarmLatch |
BOOL |
Fault alarm latch input. When true and |
|
|
|
|
|
FaultAlarm is true, latch FaultAlarm. To |
|
|
|
|
|
unlatch FaultAlarm, set |
|
|
|
|
|
FaultAlmUnlatch to true or clear |
|
|
|
|
|
FaultAlarmLatch to false. |
|
|
|
|
|
Default is false. |
|
|
|
|
|
|
|
|
|
FaultAlmUnLatch |
BOOL |
Fault alarm unlatch input. Set this |
|
|
|
|
|
input to true when FaultAlarmLatch is |
|
|
|
|
|
set to unlatch FaultAlarm. The |
|
|
|
|
|
instruction clears this input to false. |
|
|
|
|
|
Default is false. |
|
|
|
OverrideOnInit |
BOOL |
Override on initialization request. If |
|
|
|
|
|
this bit is true, then during instruction |
|
|
|
|
|
first scan, the instruction is placed in |
|
|
|
|
|
Operator control with Override true |
|
|
|
|
|
and Hand false. If ProgHandReq is true, |
|
|
|
|
|
then Override is cleared to false and |
|
|
|
|
|
Hand is set to true. |
|
|
|
|
|
Default is false. |
|
|
|
OverrideOnFault |
BOOL |
Override on fault request. Set this |
|
|
|
|
|
value to true if the device should go to |
|
|
|
|
|
Override mode and enter the Override |
|
|
|
|
|
State on a fault alarm. After the fault |
|
|
|
|
|
alarm is removed, the instruction is |
|
|
|
|
|
placed in Operator control. |
|
|
|
|
|
Default is false. |
|
|
|
Out0State0 |
BOOL |
Output 0 state 0 input. This value |
|
|
|
|
|
determines the value of Output0 when |
|
|
|
|
|
the device is in the 0 state. |
|
|
|
|
|
Default is false. |
|
|
|
Out0State1 |
BOOL |
Output 0 state 1 input. This value |
|
|
|
|
|
determines the value of Output0 when |
|
|
|
|
|
the device is in the 1 state. |
|
|
|
|
|
Default is false. |
|
|
Publication 1756-RM006L-EN-P - September 2020 |
27 |
Chapter 1 |
Process Control Instructions |
|
|
|
|
|
|
|
|
|
|
|
|
Input Parameter |
Data Type |
Description |
|
|
|
Out0State2 |
BOOL |
Output 0 state 2 input. This value |
|
|
|
|
|
determines the value of Output0 when |
|
|
|
|
|
the device is in the 2 state. |
|
|
|
|
|
Default is false. |
|
|
|
Out1State0 |
BOOL |
Output 1 state 0 input. This value |
|
|
|
|
|
determines the value of Output1 when |
|
|
|
|
|
the device is in the 0 state. |
|
|
|
|
|
Default is false. |
|
|
|
Out1State1 |
BOOL |
Output 1 state 1 input. This value |
|
|
|
|
|
determines the value of Output1 when |
|
|
|
|
|
the device is in the 1 state. |
|
|
|
|
|
Default is false. |
|
|
|
Out1State2 |
BOOL |
Output 1 state 2 input. This value |
|
|
|
|
|
determines the value of Output1 when |
|
|
|
|
|
the device is in the 2 state. |
|
|
|
|
|
Default is false. |
|
|
|
Out2State0 |
BOOL |
Output 2 state 0 input. This value |
|
|
|
|
|
determines the value of Output2 when |
|
|
|
|
|
the device is in the 0 state. |
|
|
|
|
|
Default is false. |
|
|
|
Out2State1 |
BOOL |
Output 2 state 1 input. This value |
|
|
|
|
|
determines the value of Output2 when |
|
|
|
|
|
the device is in the 1 state. |
|
|
|
|
|
Default is false. |
|
|
|
Out2State2 |
BOOL |
Output 2 state 2 input. This value |
|
|
|
|
|
determines the value of Output2 when |
|
|
|
|
|
the device is in the 2 state. |
|
|
|
|
|
Default is false. |
|
|
|
OverrideState |
DINT |
Override state input. Set this input to |
|
|
|
|
|
indicate the state of the device when |
|
|
|
|
|
in Override mode. |
|
|
|
|
|
2 = Device should go to the 2 state |
|
|
|
|
|
1 = Device should go to the 1 state |
|
|
|
|
|
0 = Device should go to the 0 state |
|
|
|
|
|
An invalid value sets the appropriate |
|
|
|
|
|
bit in Status. |
|
|
|
|
|
Valid = 0 to 2 |
|
|
|
|
|
Default = 0 |
|
|
|
FB0State0 |
BOOL |
Feedback 0 state 0 input. This value |
|
|
|
|
|
determines the expected value of FB0 |
|
|
|
|
|
when the device is in the 0 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB0State1 |
BOOL |
Feedback 0 state 1 input. This value |
|
|
|
|
|
determines the expected value of FB0 |
|
|
|
|
|
when the device is in the 1 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB0State2 |
BOOL |
Feedback 0 state 2 input. This value |
|
|
|
|
|
determines the expected value of FB0 |
|
|
|
|
|
when the device is in the 2 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB1State0 |
BOOL |
Feedback 1 state 0 input. This value |
|
|
|
|
|
determines the expected value of FB1 |
|
|
|
|
|
when the device is in the 0 state. |
|
|
|
|
|
Default is false. |
|
28 |
|
Publication 1756-RM006L-EN-P - September 2020 |
|||
|
|
|
Chapter 1 |
Process Control Instructions |
|
|
|
|
|
|
|
|
Input Parameter |
Data Type |
Description |
|
|
|
FB1State1 |
BOOL |
Feedback 1 state 1 input. This value |
|
|
|
|
|
determines the expected value of FB1 |
|
|
|
|
|
when the device is in the 1 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB1State2 |
BOOL |
Feedback 1 state 2 input. This value |
|
|
|
|
|
determines the expected value of FB1 |
|
|
|
|
|
when the device is in the 2 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB2State0 |
BOOL |
Feedback 2 state 0 input. This value |
|
|
|
|
|
determines the expected value of FB2 |
|
|
|
|
|
when the device is in the 0 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB2State1 |
BOOL |
Feedback 2 state 1 input. This value |
|
|
|
|
|
determines the expected value of FB2 |
|
|
|
|
|
when the device is in the 1 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB2State2 |
BOOL |
Feedback 2 state 2 input. This value |
|
|
|
|
|
determines the expected value of FB2 |
|
|
|
|
|
when the device is in the 2 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB3State0 |
BOOL |
Feedback 3 state 0 input. This value |
|
|
|
|
|
determines the expected value of FB3 |
|
|
|
|
|
when the device is in the 0 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB3State1 |
BOOL |
Feedback 3 state 1 input. This value |
|
|
|
|
|
determines the expected value of FB3 |
|
|
|
|
|
when the device is in the 1 state. |
|
|
|
|
|
Default is false. |
|
|
|
FB3State2 |
BOOL |
Feedback 3 state 2 input. This value |
|
|
|
|
|
determines the expected value of FB3 |
|
|
|
|
|
when the device is in the 2 state. |
|
|
|
|
|
Default is false. |
|
|
|
ProgProgReq |
BOOL |
Program program request. Set to true |
|
|
|
|
|
by the user program to request |
|
|
|
|
|
Program control. Ignored if |
|
|
|
|
|
ProgOperReq is true. Holding this true |
|
|
|
|
|
and ProgOperReq false locks the |
|
|
|
|
|
instruction in Program control. |
|
|
|
|
|
Default is false. |
|
|
|
ProgOperReq |
BOOL |
Program operator request. Set to true |
|
|
|
|
|
by the user program to request |
|
|
|
|
|
operator control. Holding this true |
|
|
|
|
|
locks the instruction in Operator |
|
|
|
|
|
control. |
|
|
|
|
|
Default is false. |
|
|
|
ProgOverrideReq |
BOOL |
Program override request. Set to true |
|
|
|
|
|
by the user program to request the |
|
|
|
|
|
device to enter Override mode. Ignored |
|
|
|
|
|
if ProgHandReq is true. |
|
|
|
|
|
Default is false. |
|
|
|
ProgHandReq |
BOOL |
Program hand request. Set to true by |
|
|
|
|
|
the user program to request the device |
|
|
|
|
|
to enter Hand mode. |
|
|
|
|
|
Default is false. |
|
|
|
Publication 1756-RM006L-EN-P - September 2020 |
29 |
|||
Chapter 1 |
Process Control Instructions |
Input Parameter |
Data Type |
Description |
OperProgReq |
BOOL |
Operator program request. Set to true |
|
|
by the operator interface to request |
|
|
Program control. The instruction |
|
|
clears this input to false. |
|
|
Default is false. |
OperOperReq |
BOOL |
Operator operator request. Set to true |
|
|
by the operator interface to request |
|
|
Operator control. The instruction |
|
|
clears this input to false. |
|
|
Default is false. |
ProgValueReset |
BOOL |
Reset program control values. When |
|
|
true, all the program request inputs |
|
|
are cleared to false at each execution |
|
|
of the instruction. |
|
|
Default is false. |
Output Parameter |
Data Type |
Description |
EnableOut |
BOOL |
Indicates if instruction is enabled. |
Out0 |
BOOL |
The first output of the instruction. |
Out1 |
BOOL |
The second output of the instruction. |
Out2 |
BOOL |
The third output of the instruction. |
Device0State |
BOOL |
Device state 0 output. True when the |
|
|
device is commanded to the 0 state and |
|
|
the feedback indicates the device really |
|
|
is in the 0 state. |
Device1State |
BOOL |
Device state 1 output. True when the |
|
|
device is commanded to the 1 state and |
|
|
the feedback indicates the device really |
|
|
is in the 1 state. |
Device2State |
BOOL |
Device state 2 output. True when the |
|
|
device is commanded to the 2 state and |
|
|
the feedback indicates the device really |
|
|
is in the 2 state. |
Command0Status |
BOOL |
Device state 0 command status. True |
|
|
when the device is being commanded to |
|
|
the 0 state; false when the device is |
|
|
being commanded to some other state. |
Command1Status |
BOOL |
Device state 1 command status. True |
|
|
when the device is being commanded to |
|
|
the 1 state; false when the device is |
|
|
being commanded to some other state. |
Command2Status |
BOOL |
Device state 2 command status. True |
|
|
when the device is being commanded to |
|
|
the 2 state; false when the device is |
|
|
being commanded to some other state. |
30 |
Publication 1756-RM006L-EN-P - September 2020 |
Loading...