P DoseWS 2.0 Syslib-rm021 -En-e
-
Upload
carbono980 -
Category
Documents
-
view
244 -
download
2
Transcript of P DoseWS 2.0 Syslib-rm021 -En-e
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
1/80
Process Add-On Instructions and Graphics:
Weigh Scale Dosing (P_DoseWS)
Reference Manual
Compatible with the Plant-wide Integrated Architecture™
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
2/80
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 officeor online at http://rockwellautomation.com/literature ) describes some important differences between solid state equipment and hard-wired
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 applicationof this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements as-sociated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the ex-
amples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described inthis 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.
Allen-Bradley, Rockwell Automation, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation, Plant PAx Process Automation System, and TechConnect are property of their respective companies.
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, oreconomic loss.
IMPORTANT Identifies information that is critical for successful application and understanding of the product.
ATTENTIONIdentifies 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.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
3/80
iiiPublication SYSLIB-RM021C-EN-E - October 2011 iii
Summary of Changes
Introduction This release of this document is updated throughout for version 2.0 of the Weigh Scale Dosing (P_DoseWS) Add-On Instruction and Graphics. Pleaserefer to the Release Notes that are distributed with version 2.0 of the Library.
Updated Information This document contains the following changes:
Change: See:
Version 2.0 of instruction All
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
4/80
iv Publication SYSLIB-RM021C-EN-E - October 2011
Summary of Changes
Notes:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
5/80
vPublication SYSLIB-RM021C-EN-E - October 2011 v
Table of Contents
Preface Use of this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Conventions and Related Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Set and Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Edge and Level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Relay Ladder Rung Condition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixPre-Scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xFunction Block States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Entering Text in FactoryTalk View SE. . . . . . . . . . . . . . . . . . . . . . xii
Chapter 1
Overview Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Primary Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Revision Compatibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Chapter 2
Configuration Options Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Chapter 3
Instruction Data Reference Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Inputs (Inp_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Outputs (Out_). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Configurations (Cfg_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Program Settings (PSet_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Program Commands (PCmd_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Device Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Mode Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Alarm Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Operator Settings, Maintenance Settings, Other Settings (OSet_, MSet_, Set_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Operator / Maintenance Setting Readies . . . . . . . . . . . . . . . . . . . . 28Operator Commands, Maintenance Commands, Command Readies (OCmd_, MCmd_, Rdy_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Device Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Mode Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Alarm Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Device Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Mode Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Alarm Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Values (Val_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Status (Sts_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Device Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Mode Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Alarm Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
6/80
vi Publication SYSLIB-RM021C-EN-E - October 2011
Table of Contents
Chapter 4
HMI Reference Graphic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Graphic Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Using Graphics Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Alarms Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Trends Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Alarm Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Weigh Scale Dosing Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . 66
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
7/80
viiPublication SYSLIB-RM021C-EN-E - October 2011 vii
Preface
Use of this Document This document provides a programmer with details on the P_DoseWSinstruction for a Logix-based controller. You should already be familiar withhow the Logix-based controller stores and processes data.
Novice programmers should read all the details about an instruction beforeusing the instruction. Experienced programmers can refer to the instructioninformation to verify details.
Conventions and RelatedTerms
Set and Clear
This manual uses set and clear to define the status of bits (booleans) and values(non-booleans):
This term: Means:
Set The bit is set to 1 (ON) A value is set to any non-zero number
Clear The bit is cleared to 0 (OFF) All the bits in a value are cleared to 0
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
8/80
viii Publication SYSLIB-RM021C-EN-E - October 2011
Preface
Edge and Level
This manual uses Edge and Level to describe how bit (BOOL) Commands,Settings, Configurations, and Inputs to this instruction are sent by other logic
and processed by this instruction.
Send/Receive Method: Description:
Edge • Action is triggered by "rising edge" transition of input (0-1)
• Separate inputs are provided for complementary functions(such as "enable" and "disable")
• Sending logic SETS the bit (writes a 1) to initiate theaction; this instruction CLEARS the bit (to 0) immediately,then acts on the request, if possible
• Ladder Diagram (LD): use conditioned OTL (Latch) to send
• Structured Text (ST): use conditional assignment [if
(condition) then bit:=1;] to send• Function Block Diagram (FBD): OREF writes a 1 or 0 every
scan, should use Level, not Edge
Edge-triggering allows multiple senders per Command,Setting, Configuration, or Input (many-to-one relationship).
Level • Action ("enable") is triggered by input being at a level (in astate, usually 1)
• Opposite action ("disable") is triggered by input being inopposite state (0)
• Sending logic SETS the bit (writes a 1) or CLEARS the bit(writes a 0); this instruction does not change the bit
• LD: use OTE (Energize) to send
• ST: use unconditional assignment[bit:= expression_resulting_in_1_or_0;] or"if-then-else" logic [if (condition) then bit:= 1; else bit:= 0;]
• FBD: use OREF to the input bit
Level triggering allows only one sender to drive each Levelinput on the instruction (one-to-one relationship restriction).
IMPORTANT All Operator Commands (OCmd_) and Maintenance Commands(MCmd_) are Edge triggered. The HMI graphic object orFaceplate SETS (writes a 1 to) each Command bit and theInstruction CLEARS (writes a 0 to) the Command bit, then
performs the function, if possible.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
9/80
Publication SYSLIB-RM021C-EN-E - October 2011 ix
Preface
Relay Ladder Rung Condition
The controller evaluates ladder instructions based on the rung conditionpreceding the instruction (rung-in condition). Based on the rung-in condition
and the instruction, the controller sets the rung condition following theinstruction (rung-out condition), which in turn, affects any subsequentinstruction.
If the rung-in condition to an input instruction is true, the controller evaluatesthe instruction and sets the rung-out condition based on the results of theinstruction. If the instruction evaluates to true, the rung-out condition is true;if the instruction evaluates to false, the rung-out condition is false.
IMPORTANT This instruction has Program Commands (PCmd_) which areselectable as Edge or Level, depending on the ConfigurationParameter Cfg_PCmdClear. If Cfg_PCmdClear is 1 (the default),all Program Commands are CLEARED when received (edge). If
Cfg_PCmdClear is 0, Program Commands as noted in theInstruction Data Reference become Level triggered, andopposite functions are triggered by the primary ProgramCommand being CLEARED to 0.
IMPORTANT The rung-in condition is reflected in the EnableIn parameter anddetermines how the system performs each Process Add-OnInstruction. If the EnableIn signal is TRUE, the system performsthe instruction’s main logic routine. Conversely, if the EnableInsignal is FALSE, the system performs the instruction’sEnableInFalse routine.
The instruction’s main logic routine sets/clears the EnableOutparameter, which then determines the rung-out condition. TheEnableInFalse routine cannot set the EnableOut parameter. Ifthe rung-in condition is FALSE, then the EnableOut parameterand the rung-out condition will also be FALSE.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
10/80
x Publication SYSLIB-RM021C-EN-E - October 2011
Preface
Pre-Scan
During the transition into RUN, the controller performs a Pre-scan before thefirst logic scan. Pre-scan is a special scan of all routines in the controller. The
controller scans all main routines and subroutines during Pre-scan, but ignoresjumps that could skip the execution of instructions. The controller executes allFOR loops and subroutine calls. If a subroutine is called more than once, it isexecuted each time it is called. The controller uses Pre-scan instructions toreset non-retentive data values.
During Pre-scan, input values are not current and outputs are not written. Thefollowing conditions generate Pre-scan:
• toggle from Program to Run mode.
• automatically enter Run mode from a power-up condition.
Pre-scan 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.
IMPORTANT The Pre-scan process performs the Process Add-On Instruction’slogic routine as all FALSE and then performs its Pre-scanroutine as TRUE.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
11/80
Publication SYSLIB-RM021C-EN-E - October 2011 xi
Preface
Function Block States
The controller evaluates function block instructions based on the state ofdifferent conditions.
Every function block instruction also includes EnableIn and EnableOutparameters.
If the EnableIn parameter is not wired, the instruction always executes asnormal and EnableIn remains set. If you clear EnableIn, it changes to set thenext time the instruction executes.
Possible Condition: Description:
Pre-scan Pre-scan for function block routines is the same as for relayladder routines. The only difference is that the Enablelnparameter for each function block instruction is cleared duringPre-scan.
Instruction first scan Instruction first scan refers to the first time an instruction isexecuted after Pre-scan. The controller uses instruction firstscan to read current inputs and determine the appropriatestate to be in.
Instruction first run Instruction first run refers to the first time the instructionexecutes with a new instance of a data structure. The
controller uses instruction first run to generate coefficientsand other data stores that do not change for a function blockafter initial download.
IMPORTANT When programming in function block, restrict the rangeof engineering units to ±10±15 because internal floatingpoint calculations are done using single precision floatingpoint. Engineering units outside of this range may result ina loss of accuracy if results approach the limitations of
single precision floating point (±10±38 ).
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
12/80
xii Publication SYSLIB-RM021C-EN-E - October 2011
Preface
Entering Text in FactoryTalk View SE
When entering data into String Input fields in FactoryTalk View SE, the data isnot saved to the tag until the user presses the Enter key. When the Input Field
is enabled, its border changes based on the state of the input:
• When the Input Field is Active (the cursor is in the field), the Input Field border is a
solid line.
• If the user modifies the data in the Input Field and moves to a different field without
pressing the Enter key, the border remains a solid line indicating that the data has not
been saved to the tag.
• If the data in the Input Field has not changed or has been written to the controller
tag, the border is a dashed line.
EXAMPLE
EXAMPLE
EXAMPLE
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
13/80
1Publication SYSLIB-RM021C-EN-E - October 2011 1
Chapter 1
Overview
The P_DoseWS (Weigh Scale Dosing) Add-On Instruction controls aningredient addition which uses a weigh scale to measure the amount ofingredient added. The weigh scale may be on the receiving vessel (gain in weight) or on the sourcing vessel (loss in weight). The weigh scale can beconnected via an analog input, device network or other connection.
Use when:
• You want to control basic dosing (ingredient addition) with basicfeatures such as bulk/dribble rate selection, Preact, automatic Preactadjustment, and the ability to start, pause and resume flow.
• You are measuring the amount of ingredient added to a destination vessel (gain in weight) or the amount transferred from a source vesselusing a weigh scale. The scale provides a weight value and can beinterfaced via an analog input card, network, or other means.
Do NOT use when:
• You measure the amount of ingredient transferred with a flowmeter.Use the P_DoseFM Instruction instead.
• You need to control precision blending. This instruction does notinclude capability for controlled-rate addition such as ratio control,digital blending or precision blending. Contact your Rockwell Automation representative for a blending solution.
• You only need a totalizer (integrator). Use the built-in TOT instructioninstead.
• You only need to display a weigh scales’s weight or generate high andlow weight alarms. Use the P_AIn analog Input Add-On Instructioninstead.
You may need additional logic when:
• You need more complicated sequencing, including special actions whenrestarting, aborting or holding an addition. This sort of sequencing is agood candidate for an Equipment Phase. Equipment Phase logic candrive the P_DoseWS instruction using its Program Mode commandsand settings.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
14/80
2 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 1 Overview
• The material transfer equipment requires complicated startup andshutdown logic. You can provide this logic separately and use theP_DoseWS outputs to trigger the logic for startup and shutdown ofingredient delivery.
Functional Description A typical sequence of Operator Commands and Settings and subsequentInstruction actions using the P_DoseWS instruction to perform ingredientdosing in Operator Mode is depicted in the figure on page 3.
Primary Operations The primary operations of the P_DoseWS Instruction are:
• Provides linear scaling of the input weight value from ‘raw’ (input card)units to ‘engineering’ (display) units.
• Uses a software ‘tare’ of the scale to establish the zero quantity startingpoint for transfer. Once the scale is tared, the instruction checks for‘unrequested’ flow, that is, an increase or decrease in scale weight beforeflow is actually started, and raises a Tare Fault alarm if such a weightchange occurs.
• Provides a rate of weight change calculation (differentiation with respectto time) to generate an inferred flow rate. The calculated rate is filteredand has a Low Cutoff, so the rate will be reported as zero when thechange in weight is only from noise on the input weight signal.
• Provides outputs to control associated equipment (pumps, valves, etc.)to start and stop flow. The Operator or the Program may start theingredient addition, then pause and resume as needed.
• Monitors the status of controlled equipment (pumps, valves, etc.). Flowis stopped and an alarm is raised on an equipment fault or if theequipment fails to respond as commanded.
• Monitors the Weight PV Input quality and communication status andprovides indication of Uncertain or Bad Weight PV. Flow is stopped andan alarm is raised on a Bad PV or communication loss.
• Provides Program or Operator entry of a Quantity to deliver (setpoint)and calculates the amount remaining to deliver and percent completeduring delivery.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
15/80
Publication SYSLIB-RM021C-EN-E - October 2011 3
Overview Chapter 1
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
16/80
4 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 1 Overview
• Provides Program or Operator entry of High and Low Tolerance limits. Allows the Program or Operator to initiate a Tolerance Check afterdelivery is complete. Provides a warning if under tolerance and allowsthe Operator to ‘bump’ the flow to make up the shortage. The bumpcan be set up as a timed bump or as an operator ‘jog’-like function.Provides an alarm if over tolerance and inhibits further flow.
• Includes the ability to automatically switch to a lower dribble flow rateas the quantity delivered approaches setpoint. Provides Operator orProgram entry of the Dribble Quantity. Provides ‘run’, ‘dribble’ and‘stop’ outputs to controlled equipment.
• Uses a Preact value to stop flow to account for material in transit, timefor equipment to stop, and delays in measurement, scan,communication, etc. Provides Operator or Program entry of the Preact value. Provides an optional automatic Preact correction based on the
error in delivery when tolerance is checked. The auto correction allowsthe Preact to ‘learn’ the correct value over time.
• Uses the standard Mode (P_Mode) Instruction to provide Mode(ownership) for entry of limits and acceptance of commands. See theOperating Modes section for more information.
Operating Modes The P_DoseWS Instruction uses the following standard Modes, implementedusing an embedded P_Mode Add-On Instruction:
The Hand and Override (Ovrd) Modes are not used. (These Modes aretypically used by the controlled equipment.)
Alarm DescriptionOperator The Operator can enter settings for Setpoint, Preact, Dribble
Quantity, and High and Low Tolerances. The Operator can clear,start and stop the totalizer, start and stop (pause) ingredient flow,initiate the tolerance check, and bump flow if needed after additionstops at the Preact.
Program Program logic can set the Setpoint, Preact, Dribble Quantity, andHigh and Low Tolerances. Program logic can clear, start and stopthe totalizer, start and stop (pause) ingredient flow and initiate thetolerance check. The Operator can still bump flow if needed afteraddition stops at the Preact.
Maintenance Identical to Operator Mode, except for Mode priority rules:
• Program cannot acquire away from Maintenance, but Programcan acquire away from Operator if Operator Mode is not locked.
• Operator cannot acquire away from Program if Program Mode islocked, but Maintenance can acquire away from Program at anytime.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
17/80
Publication SYSLIB-RM021C-EN-E - October 2011 5
Overview Chapter 1
Refer to the Process Add-On Instructions and Graphics: Mode (P_Mode)Reference Manual, publication SYSLIB-RM005, for more information.
Alarms The P_DoseWS Instruction uses the following alarms, implemented usingembedded P_Alarm Add-On Instructions:
Refer to the Process Add-On Instructions and Graphics: Alarm (P_Alarm)Reference Manual, publication SYSLIB-RM002, for more information.
Execution The following table explains the handling of instruction execution conditions.
Refer to the Logix5000 Controllers Add-On Instructions ProgrammingManual, publication 1756-PM010, for more information on Add-OnInstruction execution condition handling.
Alarm Description
Over Tolerance Raised when Tolerance Check is performed if the quantity deliveredexceeds the setpoint by more than the high tolerance limit.
Under Tolerance(warning)
Raised when the Tolerance check is performed if the quantity deliveredfalls short of the setpoint by more than the low tolerance limit.
Equipment Fault Raised if the controlled equipment asserts the Inp_CtrldEqpFault inputor if the equipment feedback signals fail to track the commanded stateof the equipment. If configured as a shed fault, this also stops flow if it
is running.Tare Fault Raised if the scale is tared and then drifts away from the tare weight
before the start flow command is received.
Condition Description
EnableIn False (False Rung) Any commands received are discarded. Allalarms are cleared. The Mode is reported as‘NO MODE’. The displayed rate is zeroed.Outputs to controlled equipment arede-energized. Other output parameters(Values and Status) hold their last value.
Powerup (Pre-Scan, First Scan) Any Commands received before First Scanare discarded.
Embedded P_Alarm instructions arehandled in accordance with their standardpowerup procedures. Refer to theReference Manual for the P_Alarm
Instruction for more information.
Postscan (SFC Transition) No SFC Postscan logic is provided.
http://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdf
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
18/80
6 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 1 Overview
Revision Compatibility The P_DoseWS Add-On Instruction in RSLogix 5000 software and theFaceplate in FactoryTalk View software are marked with revision informationas shown in the following table:.
The Instruction and Faceplate are compatible if they have the same Major andMinor Revision numbers.
The Major Revision is the first number, before the period.
The Minor Revision is the second number, after the period and before thehyphen or space.
Information after the hyphen or space indicates the Tweak Revision. TheInstruction and Faceplate do not have to have the same Tweak Revision to becompatible.
In the table above, the Add-On Instruction and Faceplate shown arecompatible because they have the same Major.Minor (1.1).
Component Example
The Add-On Instruction in RSLogix 5000 hasrevision information visible when theinstruction is selected in the ControllerOrganizer.
The Faceplate in FactoryTalk View hasrevision information visible when thepointer is paused just inside the lowerleft-hand corner of the Faceplate whencalled up on a running HMI Client.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
19/80
7Publication SYSLIB-RM021C-EN-E - October 2011 7
Chapter 2
Configuration Options
Configuration Parameters Enter the appropriate values from the following table into the P_DoseWSInstruction’s configuration parameters to configure it for your application.
Use the HMI Faceplate or the RSLogix 5000 Tag Monitor function to set theapplicable configuration parameter(s).
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
Cfg_Desc
Cfg_Label
Cfg_QtyEU
Cfg_RateEU
Cfg_Tag
’Dosing with Weigh Scale’
’Weigh Scale Dosing’
’kg’
’kg/sec’
’P_DoseWS’
Engineering These Local Tags determinethe text displayed on thevarious graphic objects andFaceplates for:
• Description
• Label (if used)
• Quantity EngineeringUnits
• Rate Engineering Units
• Tagname
Cfg_AutoAdjPct 10.0% Maintenance The Auto Adjust Percentagedetermines what percentageof the delivery error (setpointminus quantity) is appliedwhen automatically adjustingthe Preact.
IMPORTANT
This Configuration is limitedby the instruction to a rangeof 0.0 to 100.0 percent.
• Cfg_AutoAdjPreact
• OSet_Preact
• PSet_Preact
• Val_Preact
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
20/80
8 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 2 Configuration Options
Cfg_AutoAdjPreact OFF Maintenance When this parameter is:
• ON, the Preact isautomatically adjustedthe first time a ToleranceCheck is performed after adelivery and the deliveryis In Tolerance.
• OFF, the Preact is notautomatically adjusted.
IMPORTANT
If a Bump is performed after adelivery, or the delivery is outof tolerance, the adjustment
is NOT performed regardlessof this configuration, in orderto avoid applying aninappropriate adjustment.
• Alm_OverTol
• Alm_UnderTol
• Cfg_AutoAdjPct
• OCmd_Bump
• OCmd_CheckTol
• OSet_Preact
• PSet_Preact
• PCmd_CheckTol
• Val_Preact
Cfg_BumpT 0.0 sec Maintenance The Bump Time determineshow long (in seconds) flow isdelivered each time anOCmd_Bump is received.
If the Bump Time is set to 0.0,the bump function works likea jog, running the equipmentas long as the bump
command (OCmd_Bump) isasserted.
If Dribble is enabled(Cfg_HasDribble), the bumpflow energizes theOut_DribbleFlow output;otherwise, it energizes theOut_RunFlow output.
IMPORTANT
The Delivery Quantity must be
below the Setpoint but morethan the Setpoint minus thePreact for the Bump functionto be available.
• OCmd_Bump
• Out_RunFlow
• Out_DribbleFlow
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
21/80
Publication SYSLIB-RM021C-EN-E - October 2011 9
Configuration Options Chapter 2
Cfg_EqpFaultAckReqd ON AlarmConfiguration
When this parameter is:
• ON, the Acknowledge(Ack) bit is cleared whenan alarm occurs,indicating anunacknowledged alarm.An AcknowledgeCommand is required toacknowledge the alarm(set the Ack bit).
• OFF, the Acknowledge(Ack) bit is set when analarm occurs, indicatingan acknowledged alarm.No Acknowledge
Command is required.
• Ack_EqpFault
• PCmd_EqpFaultAck
• EqpFault.OCmd_Ack
• Ack_OverTol
• PCmd_OverTolAck
• OverTol.OCmd_Ack
• Ack_TareFault
• PCmd_TareFaultAck
• TareFault.OCmd_Ack
• Ack_UnderTol
• PCmd_UnderTolAck
• UnderTol.OCmd_Ack
Cfg_OverTolAckReqd ON
Cfg_TareFaultAckReqd ON
Cfg_UnderTolAckReqd ON
Cfg_EqpFaultResetReqd OFF AlarmConfiguration
When this parameter is:
• ON, each Dosing Alarm islatched, and theinstruction requires aReset after the conditionreturns to normal in orderto clear the Alarm
• OFF, the alarm clearswhen the conditionreturns to normal; noReset is needed.
IMPORTANT
The Over Tolerance and UnderTolerance Alarms aremaintained until a newtolerance check is performedor an Alarm Reset is received.If the ResetReqdConfiguration bit is set, theseAlarms are maintained untilan Alarm Reset is received.
• Inp_Reset
• Alm_EqpFault
• EqpFault.OCmd_Reset
• Alm_OverTol
• OverTol.OCmd_Reset
• Alm_TareFault
• TareFault.OCmd_Reset
• Alm_UnderTol
• UnderTol.OCmd_Reset
Cfg_OverTolResetReqd OFF
Cfg_TareFaultResetReqd OFF
Cfg_UnderTolResetReqd OFF
Cfg_EqpFaultSeverity 4 Alarm
Configuration
These parameters determine
the Severity of each alarm,and thus the color of alarmanimations for each alarm. Valid values are:
1 = Information (blue)2 = Warning (yellow)3 = Exception (red)4 = Fault (magenta)
• Val_Notify
Cfg_OverTolSeverity 3
Cfg_TareFaultSeverity 4
Cfg_UnderTolSeverity 2
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
22/80
10 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 2 Configuration Options
Cfg_FaultT 10 Engineering Time for Equipment Feedbackto follow Output before Fault(sec)
• Inp_RunFdbk
• Inp_DribbleFdbk
• Inp_StopFdbk
• Sts_EqpFault
• Alm_EqpFault
• Cfg_HasEqpFdbk
• Cfg_UseEqpFdbk
Cfg_HasDribble OFF Engineering Set this parameter:
• ON if you want thecontrolled equipment toslow to a reduced“dribble” or “trickle” ratewhen the quantity
delivered approaches thesetpoint. Out_RunFlowwill be de-energized andOut_DribbleFlow will beenergized when thequantity delivered is lessthan the setpoint by(Val_DribbleQty +Val_Preact).
• OFF if the controlledequipment cannot beslowed to a reduceddelivery rate or you do not
want to slow delivery asthe delivered quantityapproaches setpoint.
• Out_RunFlow
• Out_DribbleFlow
• OSet_DribbleQty
• PSet_DribbleQty
• Val_DribbleQty
• Val_Preact
• Val_Qty
• Val_SP
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
23/80
Publication SYSLIB-RM021C-EN-E - October 2011 11
Configuration Options Chapter 2
Cfg_HasEqpFdbk OFF Engineering Set this parameter:
• ON if the controlledequipment providesfeedback signals and thesignals are connected toInp_RunFdbk,Inp_DribbleFdbk andInp_StopFdbk.
• OFF if the controlledequipment has nofeedback to thisinstruction. Theinstruction will simulatethe equipment status.This configuration
identified whether theequipment feedbacksexist. Cfg_UseEqpFdbkdetermines whether thefeedbacks are actuallyused.
• Inp_RunFdbk
• Inp_DribbleFdbk
• Inp_StopFdbk
• Sts_EqpFault
• Alm_EqpFault
• Cfg_FaultT
Cfg_UseEqpFdbk OFF Maintenance This parameter is typicallyused on a temporary basis byMaintenance. Set thisparameter:
• ON if the equipmentfeedback signals
connected toInp_RunFdbk,Inp_DribbleFdbk andInp_StopFdbk should beused for equipment failurechecking.
• OFF to disable feedbackchecking and theEquipment Fail alarm. Theinstruction will simulatethe equipment feedback.This configurationidentifies whether theequipment feedbacks
should be used.Cfg_HasEqpFdbkdetermines whether thefeedbacks exist. If thefeedbacks do not exist(Cfg_HasEqpFdbk = 0),this parameter is forced toOFF.
• Inp_RunFdbk
• Inp_DribbleFdbk
• Inp_StopFdbk
• Sts_EqpFault
• Alm_EqpFault
• Cfg_FaultT
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
24/80
12 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 2 Configuration Options
Cfg_HasEqpFaultAlm OFF AlarmConfiguration
These parameters determinewhether the correspondingalarm exists and will bechecked for, or doesn’t existand will not be used.
When these parameters are:
• ON, the Alarm exists andwill be checked
• OFF, the Alarm does notexist and will not be used
• Alm_EqpFault
Cfg_HasOverTolAlm OFF • Alm_OverTol
Cfg_HasTareFaultAlm OFF • Alm_TareFault
Cfg_HasUnderTolAlm OFF • Alm_UnderTol
Cfg_InpRawMax 10000.0 Maintenance Enter the maximum andminimum raw (unscaled)input values from the scaleconnected to Inp_WeightPVThe scale input is scaled toengineering units, thenshown on Val_PV.
• Cfg_PVEUMax
• Cfg_PVEUMin
• Inp_WeightPV
• Val_PV
Cfg_InpRawMin 0.0
Cfg_LossInWeight OFF Engineering Set this parameter:
• ON if you will betransferring material outof the vessel beingweighed (Loss in Weighttransfer). As the vesselweight decreases, thereported quantity(Val_Qty) increases and a
positive flow rate(Val_Rate) is reported.
• OFF if you will betransferring material intothe vessel being weighed(Gain in Weight transfer).As the vessel weightincreases, the reportedquantity (Val_Qty)increases and a positiveflow rate (Val_Rate) isreported.
• Inp_WeightPV
• Val_Qty
• Val_Rate
Cfg_MaxQty 1.0E+38 Maintenance This parameter determines
the maximum allowedquantity to deliver. Val_SP islimited to be less than orequal to Cfg_MaxQty.
• OSet_SP
• PSet_SP
• Val_SP
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
25/80
Publication SYSLIB-RM021C-EN-E - October 2011 13
Configuration Options Chapter 2
Cfg_OperKeep 2#0000_0000 Engineering Set bits within this 8-bitinteger to select functions tokeep under Operator controleven when this instruction isin Program mode. Clear bitsto leave the correspondingfunctions under control of theinstruction Mode.
Bit .0: Operating Commands(Start/Stop Delivery and TareScale)
Bit .1: Delivery Setpoint
Bit .2: Dribble and Preact
quantities
Bit .3: Tolerances
IMPORTANT
A function cannot be reservedfor Operator usingCfg_OperKeep and also berecessives for Program usingCfg_ProgKeep. And at leastone function must be "notkept" (remain under control ofthe instruction Mode).
• OCmd_Tare
• OCmd_StartFlow
• OCmd_StopFlow
• OCmd_CheckTol
• OCmd_Bump
• OSet_SP
• OSet_DribbleQty
• OSet_Preact
• OSet_TolHi
• OSet_TolLo
• Err_Keep
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
26/80
14 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 2 Configuration Options
Cfg_ProgKeep 2#0000_0000 Engineering Set bits within this 8-bitinteger to select functions tokeep under Program controleven when this instruction isin Operator Mode. Clear bitsto leave the correspondingfunctions under control of theinstruction Mode.
Bit.0: Operating Commands(Start / Stop Delivery andTare Scale)
Bit.1: Delivery Setpoint
Bit.2: Dribble and Preact
quantities
Bit.3: Tolerances
IMPORTANTTIP
A function cannot bereserved for Operator usingCfg_OperKeep and also bereserved for Program usingCfg_ProgKeep. And at leastone function must be "notkept" (remain under control ofthe Instruction Mode).
• PCmd_Tare
• PCmd_StartFlow
• PCmd_StopFlow
• PCmd_CheckTol
• PSet_SP
• PSet_DribbleQty
• PSet_Preact
• PSet_TolHi
• PSet_TolLo
• Err_Keep
Cfg_PCmdClear ON Engineering Set this parameter:
• ON to use Edge-triggeredProgram Commands.
• OFF to use Level-triggeredProgram Commands.
See the Edge and Level section in the Preface formore information.
The Cfg_PCmdClearparameter configures allProgram Commands (PCmd_) for either Level or Edgetriggering.
Cfg_ProgDefault OFF Engineering When this parameter is:
• ON, the Mode defaults toProgram if no Mode isbeing requested.
• OFF, the Mode defaults toOperator if no Mode isbeing requested.
IMPORTANT
Changing this parameteronline may cause unintendedmode changes.
• Val_Mode
• Sts_Prog
• Sts_Oper
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
27/80
Publication SYSLIB-RM021C-EN-E - October 2011 15
Configuration Options Chapter 2
Cfg_PVEUMax 10000.0 Maintenance Enter the maximum andminimum engineering unitvalues (scaled) for the scaleweight. The signal connectedto Inp_WeightPV is scaledfrom input (raw) units toengineering units, thenshown as Val_PV
• Cfg_InpRawMax
• Cfg_InpRawMin
• Inp_WeightPV
• Val_PV
Cfg_PVEUMin 0.0
Cfg_RateFiltTC 0.1 sec Maintenance Set this parameter to theTime Constant to be used infiltering the Val_Rate signalgenerated when calculatingthe flow rate based on thechanging weight(Inp_WeightPV) input.
The filter helps eliminatejitter in the calculated ratecaused by uneven and/orasynchronous I/O updatesand program scans.Increasing the Time Constantremoves more noise from thesignal but makes its responseslower. A value of 0.0disables the filter and theinstantaneous weightrate-of-change is reported.
• Cfg_RateTime
• Inp_WeightPV
• Val_Rate
Cfg_RateTime 1.0 sec Engineering This parameter is the time
base for the quantity to ratedifferentator (rate of change).Enter the number of secondsin the denominator (“per”) ofthe rate units of measure. Forexample, if the flow is inPounds per Minute, enter60.0 (seconds in a minute).
• Inp_WeightPV
• Val_Rate
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
28/80
16 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 2 Configuration Options
Cfg_SetTrack ON Maintenance When this parameter is:
• ON, Operator Settingstrack the ProgramSettings when the Modeis Program, and ProgramSettings track theOperator Settings whenthe Mode is Operator.Transition betweenModes is bumpless.
• OFF, Operator Settingsand Program Settings arenot modified by thisinstruction and retain theirvalues regardless of
Program or OperatorMode. When the mode ischanged, the value of theoutput may bump, sayfrom the Program-setvalue to the Operator-setvalue.
• OSet_DribbleQty
• OSet_Preact
• OSet_SP
• OSet_TolHi
• OSet_TolLo
• PSet_DribbleQty
• PSet_Preact
• PSet_SP
• PSet_TolHi
• PSet_TolLo
Cfg_SimDribbleRate 0.1 EU / rate time Engineering This parameter determinesthe flow rate presented(Val_Rate) when runningDribble Flow(Out_DribbleFlow) insimulation. This rate is
integrated (totalized) togenerate the delivery quantity(Val_Qty).
IMPORTANT
In Simulation, the simulationflow rate is integrated(totalized) to a deliveryquantity. In normal operation,the weight (Val_PV) isdifferentiated (rate of changecalculated) to determine flowrate.
• Cfg_RateTime
• Inp_Sim
• Out_DribbleFlow
• Val_Qty
• Val_Rate
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
29/80
Publication SYSLIB-RM021C-EN-E - October 2011 17
Configuration Options Chapter 2
Cfg_SimRate 1.0 EU / rate time Engineering This parameter determinesthe flow rate presented(Val_Rate) when running fullflow (Out_RunFlow) insimulation. This rate isintegrated (totalized) togenerate the delivery quantity(Val_Qty).
IMPORTANT
In Simulation, the simulationflow rate is integrated(totalized) to a deliveryquantity. In normal operation,the weight (Val_PV) isdifferentiated (rate of changecalculated) to determine flowrate.
• Cfg_RateTime
• Inp_Sim
• Out_RunFlow
• Val_Qty
• Val_Rate
Cfg_SimStartWt 0.0 EU Engineering In Simulation, when a Tarecommand is received, thescale weight (Val_PV) and theTare weight (Val_Tare) are setto this value. (Since the tareand scale are equal, thedelivered quantity Val_Qtybecomes zero.)
In normal operation, the Tare
command copies the currentscale weight (Val_PV) to theTare weight (Val_Tare).(Again, the tare and scale areequal and the deliveredquantity Val_Qty becomeszero.)
IMPORTANT
In Simulation, the Tarecommand will cause a“bump” in the weight PV
(Val_PV) as it is “reinitialized”to this Start Weight. To avoidthe bump, copy Val_PV toCfg_SimStartWt in your code.The purpose of this parameteris to make it easy for anoperator in training to runmany simulated transferswithout running thesimulated scale weightoutside the scaled range.
• Inp_Sim
• Val_Qty
• Val_PV
• Val_Tare
Parameter: Default:Faceplate TabLocation: Usage: Associated Parameters:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
30/80
18 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 2 Configuration Options
Notes:
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
31/80
19Publication SYSLIB-RM021C-EN-E - October 2011 19
Chapter 3
Instruction Data Reference
This chapter describes the P_DoseWS Instruction’s public parameters.
The descriptions in the tables below show how these data elements are used with the P_DoseWS Add-On Instruction.
Execution Execution parameters are included with every Add-On Instruction. See theLogix5000 Controllers Add-On Instructions Programming Manual,publication 1756-PM010, for more information on these data elements.
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
EnableIn BOOL Input 1 Enable Input:1 = Normal Scan: control / monitor Dosing
with Flowmeter0 = Clear any ’lurking’ Commands and all
Readies, set NO MODE
EnableOut BOOL Output 0 Enable Output: The EnableOut signal isnot manipulated by this instruction. Itsoutput state always reflects the EnableIn
input state.Inf_Tab BOOL Output 0 Tab to display (FTView ME)
Inf_Type BOOL Output ’P_DoseWS’ Must contain AOI name, used for HMI andInformation S/W
P_DoseWS BOOL Output 0 Unique Parameter Name for auto -discovery
http://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdfhttp://literature.rockwellautomation.com/idc/groups/literature/documents/pm/1756-pm010_-en-p.pdf
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
32/80
20 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Inputs (Inp_)
Input data elements are used to connect field inputs from I/O modules orsignals from other objects to the P_DoseWS instruction. Each Input usedshould have mapping logic or a function block wire to get the input value fromthe input card or other instruction every scan.
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Inp_WeightPV REAL Input 0.0 Float Weight from Weigh Scale (unscaled) • Cfg_InpRawMax
• Cfg_InpRawMin
• Cfg_LossInWeight
• Cfg_PVEUMin
• Cfg_PVEUMin
• Cfg_RateFiltTC
• Cfg_RateTime
Inp_RunFdbk BOOL Input 0 Level 1 = Controlled Equipment is Delivering(Running)
Inp_DribbleFdbk BOOL Input 0 Level 1 = Controlled Equipment is Deliveringat Dribble
Inp_StopFdbk BOOL Input 0 Level 1 = Controlled Equipment is ConfirmedStopped
Inp_PVBad BOOL Input 0 Level 1 = Scale PV or I/O Quality Bad0 = OK
Inp_PVUncertain BOOL Input 0 Level 1 = Scale PV Quality Uncertain0 = OK
Inp_CtrldEqpFault BOOL Input 0 Level Controlled Equipment device or I/O
status
0 = OK1 = Fail
Inp_Sim BOOL Input 0 Level 1 = Simulate working weigh scale0 = Use actual weight input
• Cfg_SimDribbleRate
• Cfg_SimRate
• Cfg_SimStartWt
Inp_Reset BOOL Input 0 Level 1 = Reset all fault conditions andlatched Alarms
• Cfg_EqpFaultResetReqd
• Cfg_OverTolResetReqd
• Cfg_UnderTolResetReqd
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
33/80
Publication SYSLIB-RM021C-EN-E - October 2011 21
Instruction Data Reference Chapter 3
Outputs (Out_)
Output data elements are used to connect from the P_DoseWS Instruction tofield outputs on I/O modules or to other objects. Each Output used shouldhave mapping logic or a function block wire to write the output value to theoutput card or other object every scan.
Configurations (Cfg_)
Configuration data elements are used to set configurable capabilities, featuresand functions of the P_DoseWS Instruction.
The following Configuration data may be modified using the controllerapplication logic, using the HMI Faceplate, or using the Tag Monitor isRSLogix 5000 Software.
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Out_RunFlow BOOL Output 0 1 = Deliver at Full (fast) Flow • Cfg_BumpT
• Cfg_HasDribble
• Cfg_SimRate
Out_DribbleFlow BOOL Output 0 1 = Deliver at Dribble (slow) Flow • Cfg_BumpT
• Cfg_HasDribble
• Cfg_SimDribbleRate
Out_StopFlow BOOL Output 0 1 = Stop Delivery Equipment
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Cfg_LossInWeight BOOL Input 0 Level 1 = Running reduces weight(Xfer Out)
0 = Running increases weight(Xfer In)
Cfg_HasDribble BOOL Input 0 Level 1 = Slow to Dribble beforecomplete
0 = Run full flow until complete
Cfg_HasEqpFdbk BOOL Input 0 Level 1 = Controlled Equipmentprovides Run (Dribble ifused) and Stop Feedback
• Inp_RunFdbk
• Inp_DribbleFdbk
• Inp_StopFdbk
• Sts_EqpFault
• Alm_EqpFault
• Cfg_FaultT
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
34/80
22 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Cfg_UseEqpFdbk BOOL Input 0 Level 1 = Use run / dribble / stopfeedback, 0=Assumeequipment state
• Inp_RunFdbk
• Inp_DribbleFdbk • Inp_StopFdbk
• Sts_EqpFault
• Alm_EqpFault
• Cfg_FaultT
Cfg_AutoAdjPreact BOOL Input 0 Level 1 = Enable automaticadjustment of preact aftereach delivery
• Cfg_AutoAdjPct
Cfg_SetTrack BOOL Input 1 Level 1 = PSets track OSets in Oper,OSets track PSets in Prog
0 = No tracking
Cfg_PCmdClear BOOL Input 1 Level 1 = Clear Program Commandson receipt
0 = Leave Set
Cfg_ProgDefault BOOL Input 0 Level Default Mode:1 = Program Mode if no
requests0 = Operator Mode if no
requests
• Val_Mode
• Sts_Prog
• Sts_Oper
Cfg_ShedOnEqpFault BOOL Input 0 Decimal 1 = Stop delivery and Alarm onEquipment Fault; 0=Alarmonly on Equipment Fault
Cfg_HasOverTolAlm BOOL Input 0 Level 1 = Over Tolerance Alarm exists
and will be checkedCfg_HasUnderTolAlm BOOL Input 0 Level 1 = Under Tolerance Alarm
exists and will be checked
Cfg_HasTareFaultAlm BOOL Input 0 Level 1 = Tare Fault Alarm exists andwill be checked
Cfg_HasEqpFaultAlm BOOL Input 0 Level 1 = Equipment Fault Alarmexists and will be checked
Cfg_OverTolResetReqd BOOL Input 0 Level 1 = Reset required to clear OverTolerance Alarm
Cfg_UnderTolResetReqd BOOL Input 0 Level 1 = Reset required to clearUnder Tolerance Alarm
Cfg_TareFaultResetReqd BOOL Input 0 Level 1 = Reset required to clear TareFault Alarm
Cfg_EqpFaultResetReqd BOOL Input 0 Level 1 = Reset required to clearEquipment Fault Alarm
Cfg_OverTolAckReqd BOOL Input 1 Level 1 = Acknowledge required forOver Tolerance Alarm
Cfg_UnderTolAckReqd BOOL Input 1 Level 1 = Acknowledge required forUnder Tolerance Alarm
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
35/80
Publication SYSLIB-RM021C-EN-E - October 2011 23
Instruction Data Reference Chapter 3
Cfg_TareFaultAckReqd BOOL Input 1 Level 1 = Acknowledge required forTare Fault Alarm
Cfg_EqpFaultAckReqd BOOL Input 1 Level 1 = Acknowledge required forEquipment Fault Alarm
Cfg_OverTolSeverity SINT Input 3 Decimal Over Tolerance Alarm Severity
1 = Information2 = Warning3 = Exception4 = Fault
Cfg_UnderTolSeverity SINT Input 2 Decimal Under Tolerance Alarm Severity
1 = Information2 = Warning
3 = Exception4 = Fault
Cfg_TareFaultSeverity SINT Input 2 Decimal Tare Fault Alarm Severity
1 = Information2 = Warning3 = Exception4 = Fault
Cfg_EqpFaultSeverity SINT Input 4 Decimal Equipment Fault Alarm Severity
1 = Information2 = Warning3 = Exception4 = Fault
Cfg_InpRawMin REAL Input 0.0 Float Minimum unscaled weightinput
• Cfg_PVEUMin
• Cfg_PVEUMin
Cfg_InpRawMax REAL Input 10000.0 Float Maximum unscaled weightinput
• Cfg_PVEUMin
• Cfg_PVEUMin
Cfg_PVEUMin REAL Input 0.0 Float Minimum scaled weight PVinput (EU)
• Cfg_InpRawMax
• Cfg_InpRawMin
Cfg_PVEUMax REAL Input 10000.0 Float Maximum scaled weight PVinput (EU)
• Cfg_InpRawMax
• Cfg_InpRawMin
Cfg_MaxQty REAL Input 1.0E+38 Float Maximum allowed quantity todeliver (setpoint) (EU)
Cfg_RateTime REAL Input 1.0 Float Time factor for rate (60 for /min,3600 for /hr) (Sec)
• Cfg_RateFiltTC
• Cfg_SimDribbleRate
• Cfg_SimRate
Cfg_RateFiltTC REAL Input 0.1 Float Filter Time Constant (sec) forcalculated Rate
Cfg_BumpT REAL Input 0.0 Float Bump (manual top-off) Time(Sec)
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
36/80
24 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Because they contain arrayed or structured data types, the followingConfiguration Data Elements use P_DoseWS Add-On Instruction Local Tags.These may be modified using RSLogix 5000 or using the HMI Faceplates, but
cannot be modified using controller logic:
Cfg_AutoAdjPct REAL Input 10.0 Float Percentage of delivery error toauto-adjust preact (%)
• Cfg_AutoAdjPreact
Cfg_SimStartWt REAL Input 0.0 Float Weight to start from (tare to) insimulation (EU)
Cfg_SimRate REAL Input 1.0 Float Rate at which to deliver whenrunning in Simulation (EU/ratetime)
Cfg_SimDribbleRate REAL Input 0.1 Float Rate at which to dribble whenrunning in Simulation (EU/ratetime)
Cfg_FaultT DINT Input 10 Decimal Time for Equipment Feedback tofollow Output before Fault (sec)
Cfg_OperKeep SINT Input 2#0000_
0000
Binary Oper keeps control in Program
Mode:
.0 = Start/Stop
.1=SP
.2=Dribble/Preact
.3=Tolerances
Cfg_ProgKeep SINT Input 2#0000_0000
Binary Prog keeps control in OperMode:
.0 = Start/Stop
.1=SP
.2=Dribble/Preact
.3=Tolerances
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Cfg_Desc STRING_40 'Dosing withWeigh Scale’
String Description for display on HMI
Cfg_Label STRING_20 ’Weigh ScaleDosing’
String Label for Graphic Object displayedon HMI
Cfg_QtyEU STRING_8 'kg' String Engineering Units for Quantity fordisplay on HMI
Cfg_RateEU STRING_8 'kg/sec' String Engineering Units for Rate (flow)for display on HMI
Cfg_Tag STRING_20 'P_DoseWS' String Tagname for display on HMI
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
37/80
Publication SYSLIB-RM021C-EN-E - October 2011 25
Instruction Data Reference Chapter 3
Program Settings (PSet_)
Program Setting data elements are used by application logic to establishsetpoints, thresholds, and other settings of the P_DoseWS Instruction. Automation logic may write to these settings any time; the P_DoseWSInstruction uses them in its logic when it is in the Program Mode.
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
PSet_SP REAL Input 0.0 Float Program Setting of total quantity todeliver (EU)
• Cfg_MaxQty
• Cfg_SetTrack
PSet_DribbleQty REAL Input 0.0 Float Program Setting of quantity to dribble(EU)
• Cfg_HasDribble
• Cfg_SetTrack
PSet_Preact REAL Input 0.0 Float Program Setting of amount before totalto stop flow (EU)
• Cfg_AutoAdjPct
• Cfg_AutoAdjPreact
• Cfg_SetTrack
PSet_TolHi REAL Input 0.0 Float Program Setting of High Tolerance Limit(OK amount > SP)
• Cfg_SetTrack
PSet_TolLo REAL Input 0.0 Float Program Setting of Low Tolerance Limit(OK amount < SP)
• Cfg_SetTrack
PSet_Owner DINT Input 0 Decimal Program Owner Request ID (non-zero)or Release (zero)
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
38/80
26 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Program Commands(PCmd_)
Program Command data elements are used by application logic to requestP_DoseWS Instruction actions, such as changing Modes, acknowledgingalarms, or specific P_DoseWS actions. Application logic sets the ProgramCommand to 1 or 0 to request the action. (See the Edge and Level section inthe Preface for more information). The P_DoseWS Instruction then performsthe requested action if it is in Program Mode and the action can be performed.
Device Commands
* Primary Function: If Cfg_PCmdClear = 0, triggered by Level = 1 If Cfg_PCmdClear = 1, triggered by rising Edge
* * Opposite Function: If Cfg_PCmdClear = 0, triggered by primary function bit Level = 0 (this bit NOT USED) If Cfg_PCmdClear = 1, triggered by rising Edge of this bit
Mode Commands
* Primary Function: If Cfg_PCmdClear = 0, triggered by Level = 1 If Cfg_PCmdClear = 1, triggered by rising Edge
* * Opposite Function: If Cfg_PCmdClear = 0, triggered by primary function bit Level = 0 (this bit NOT USED) If Cfg_PCmdClear = 1, triggered by rising Edge of this bit
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
PCmd_Tare BOOL Input 0 * Program Command to Tare (resetdelivered qty to 0)
PCmd_StartFlow BOOL Input 0 * Program Command to Start Delivery
PCmd_StopFlow BOOL Input 0 ** Program Command to Stop/PauseDelivery
PCmd_CheckTol BOOL Input 0 * Program Command to CheckTolerances
• Cfg_AutoAdjPreact
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
PCmd_Acq BOOL Input 0 * Program Command to Acquireownership (Oper to Prog)
PCmd_Rel BOOL Input 0 ** Program Command to Releaseownership (Prog to Oper)
PCmd_Lock BOOL Input 0 * Program Command to Lock Mode inProg
PCmd_Unlock BOOL Input 0 ** Program Command to Unlock Mode
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
39/80
Publication SYSLIB-RM021C-EN-E - October 2011 27
Instruction Data Reference Chapter 3
Alarm Commands
* Primary Function:
If Cfg_PCmdClear = 0, triggered by Level = 1 If Cfg_PCmdClear = 1, triggered by rising Edge
* * Opposite Function: If Cfg_PCmdClear = 0, triggered by primary function bit Level = 0 (this bit NOT USED) If Cfg_PCmdClear = 1, triggered by rising Edge of this bit
Name:DataType: Usage: Default: Style: Description:
AssociatedConfiguration Parameter
PCmd_Reset BOOL Input 0 * Program Command to Reset allAlarms requiring Reset
• Cfg_EqpFaultResetReqd
• Cfg_OverTolResetReqd
• Cfg_TareFaultResetReqd
• Cfg_UnderTolResetReqd
PCmd_OverTolAck BOOL Input 0 * Program Command toAcknowledge Out of ToleranceHigh Alarm
• Cfg_OverTolAckReqd
PCmd_OverTolInhibit BOOL Input 0 * Program Command to Inhibit Outof Tolerance High Alarm
PCmd_OverTolUninhibit BOOL Input 0 ** Program Command to UninhibitOut of Tolerance High Alarm
PCmd_UnderTolAck BOOL Input 0 * Program Command toAcknowledge Out of ToleranceLow Alarm
• Cfg_UnderTolAckReqd
PCmd_UnderTolInhibit BOOL Input 0 * Program Command to Inhibit Outof Tolerance Low Alarm
PCmd_UnderTolUninhibit BOOL Input 0 ** Program Command to UninhibitOut of Tolerance Low Alarm
PCmd_TareFaultAck BOOL Input 0 * Program Command toAcknowledge Tare Fault Alarm
• Cfg_TareFaultAckReqd
PCmd_TareFaultInhibit BOOL Input 0 * Program Command to Inhibit TareFault Alarm
PCmd_TareFaultUninhibit BOOL Input 0 ** Program Command to UninhibitTare Fault Alarm
PCmd_EqpFaultAck BOOL Input 0 * Program Command toAcknowledge Equipment FaultAlarm
• Cfg_EqpFaultAckReqd
PCmd_EqpFaultInhibit BOOL Input 0 * Program Command to InhibitEquipment Fault Alarm
PCmd_EqpFaultUninhibit BOOL Input 0 ** Program Command to UninhibitEquipment Fault Alarm
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
40/80
28 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Operator Settings, Maintenance Settings, Other Settings
(OSet_, MSet_, Set_)
Operator, Maintenance and Other Setting data elements are used by the HMIFaceplate to let the operator establish setpoints, thresholds, and other settingsof the P_DoseWS Instruction. The P_DoseWS Instruction uses OtherSettings in its logic regardless of Mode. It uses Operator and MaintenanceSettings when it is in the Operator or Maintenance Mode.
Operator / Maintenance Setting Readies
Operator / Maintenance Setting Readies are used to enable (1) or gray-out (0)the Setting data entry fields on the HMI faceplate. Specific ready bits are usedfor certain Operator or Maintenance Settings. Rdy_OSet applies to allOperator or Maintenance Settings for which there are no specific Ready bits.
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
OSet_SP REAL Input 0.0 Float Operator Setting of total quantity todeliver (EU)
• Cfg_MaxQty
• Cfg_SetTrack
OSet_DribbleQty REAL Input 0.0 Float Operator Setting of quantity to dribble(EU)
• Cfg_HasDribble
• Cfg_SetTrack
OSet_Preact REAL Input 0.0 Float Operator Setting of amount before totalto stop flow (EU)
• Cfg_AutoAdjPct
• Cfg_AutoAdjPreact
• Cfg_SetTrack
OSet_TolHi REAL Input 0.0 Float Operator Setting of High ToleranceLimit (OK amount > SP)
• Cfg_SetTrack
OSet_TolLo REAL Input 0.0 Float Operator Setting of Low Tolerance Limit(OK amount < SP)
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Rdy_OSet BOOL Output 0 1 = Ready to receive OSets (enablesdata entry fields)
Rdy_SP BOOL Output 0 1 = Ready to receive OSet_SP
Rdy_DribPre BOOL Output 0 1 = Ready to receive OSet_DribbleQtyor OSet_Preact
Rdy_Tol BOOL Output 0 1 = Ready to receive OSet_TolHi orOset_TolLo
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
41/80
Publication SYSLIB-RM021C-EN-E - October 2011 29
Instruction Data Reference Chapter 3
Operator Commands, Maintenance Commands, Command Readies
(OCmd_, MCmd_, Rdy_)
Operator Commands and Maintenance Commands are used by the operator atthe HMI to request instruction actions, such as changing modes;acknowledging, enabling or disabling, suppressing or unsuppressing alarms; orother instruction-specific actions. Unless identified as “Level” below, theseCommands are set (latched) by the HMI and are read and then cleared(unlatched) and acted upon by the P_DoseWS instruction, allowing amany-to-one relationship between HMI requestors and each Command.Commands are implemented as public Input Parameters of the instruction oras Input Parameters of instructions internal to the P_DoseWS instruction(‘embedded Commands’).
Device Commands
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
OCmd_Tare BOOL Input 0 Edge Operator Command to Tare(reset delivered qty to 0)
OCmd_StartFlow BOOL Input 0 Edge Operator command to StartDelivery
OCmd_StopFlow BOOL Input 0 Edge Operator Command toStop/Pause Delivery
OCmd_CheckTol BOOL Input 0 Edge Operator Command to CheckTolerances
• Cfg_AutoAdjPreact
OCmd_Bump BOOL Input 0 Edge ifCfg_BumpT>0
Level ifCfg_BumpT=0
Operator Command to BumpDelivery for Under Tolerance
• Cfg_AutoAdjPreact
• Cfg_BumpT
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
42/80
30 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Mode Commands
Alarm Commands
IMPORTANT Mode Commands are sent to a P_Mode Instruction embeddedwithin the P_DoseWS Instruction. The P_Mode Instructioninstance is named ‘Mode’.
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Mode.MCmd_Acq BOOL Input 0 Edge Maintenance Command to AcquireOwnership (Oper/Prog/Ovrd to Maint)
Mode.MCmd_Rel BOOL Input 0 Edge Maintenance Command to ReleaseOwnership (Maint to Oper/Prog/Ovrd)
Mode.OCmd_AcqLock BOOL Input 0 Edge Operator Command to Acquire and LockMode in Oper
Mode.OCmd_Unlock BOOL Input 0 Edge Operator command to Unlock OperatorMode
IMPORTANT Alarm Commands are sent to P_Alarm Instructions embeddedwithin the P_DoseWS Instruction. Each P_Alarm Instructioninstance is named for the alarm condition.
Name:DataType: Usage: Default: Style: Description:
AssociatedConfiguration Parameter
OCmd_Reset BOOL Input 0 Edge Operator Command to Resetall Alarms requiring Reset
OCmd_ResetAckAll BOOL Input 0 Edge Operator Command to Resetall Alarms and latched Shedconditions
OverTol.OCmd_Reset BOOL Input 0 Edge Operator Command to Resetlatched Over Tolerance Alarm
• Cfg_OverTolResetReqd
OverTol.OCmd_Ack BOOL Input 0 Edge Operator Command to
Acknowledge Over ToleranceAlarm
• Cfg_OverTolAckReqd
OverTol.OCmd_Disable BOOL Input 0 Edge Operator Command to DisableOver Tolerance Alarm
OverTol.OCmd_Enable BOOL Input 0 Edge Operator Command to EnableOver Tolerance Alarm
UnderTol.OCmd_Reset BOOL Input 0 Edge Operator Command to Resetlatched Under ToleranceAlarm
• Cfg_UnderTolResetReqd
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
43/80
Publication SYSLIB-RM021C-EN-E - October 2011 31
Instruction Data Reference Chapter 3
Device Command Readies
Each Operator or Maintenance Command has a corresponding Ready bit which indicates whether the Command will be accepted and acted upon whenreceived. The Ready bit is used to enable (1) or gray-out (0) the Commandbutton on the Faceplate.
UnderTol.OCmd_Ack BOOL Input 0 Edge Operator Command toAcknowledge UnderTolerance Alarm
• Cfg_UnderTolAckReqd
UnderTol.OCmd_Disable BOOL Input 0 Edge Operator Command to DisableUnder Tolerance Alarm
UnderTol.OCmd_Enable BOOL Input 0 Edge Operator Command to EnableUnder Tolerance Alarm
TareFault.OCmd_Reset BOOL Input 0 Edge Operator Command to Resetlatched Tare Fault Alarm
• Cfg_TareFaultResetReqd
TareFault.OCmd_Ack BOOL Input 0 Edge Operator Command toAcknowledge Tare FaultAlarm
• Cfg_TareFaultAckReqd
TareFault.OCmd_Disable BOOL Input 0 Edge Operator Command to DisableTare Fault Alarm
TareFault.OCmd_Enable BOOL Input 0 Edge Operator Command to EnableTare Fault Alarm
EqpFault.OCmd_Reset BOOL Input 0 Edge Operator Command to Resetlatched Equipment FaultAlarm
• Cfg_EqpFaultResetReqd
EqpFault.OCmd_Ack BOOL Input 0 Edge Operator Command toAcknowledge Equipment FaultAlarm
• Cfg_EqpFaultAckReqd
EqpFault.OCmd_Disable BOOL Input 0 Edge Operator Command to DisableEquipment Fault Alarm
EqpFault.OCmd_Enable BOOL Input 0 Edge Operator Command to Enable
Equipment Fault Alarm
Name:DataType: Usage: Default: Style: Description:
AssociatedConfiguration Parameter
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Rdy_Tare BOOL Output 0 1 = Ready for OCmd_Tare (enables HMIbutton)
Rdy_StartFlow BOOL Output 0 1 = Ready for OCmd_StartFlow (enablesHMI button)
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
44/80
32 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Mode Command Readies
Alarm Command Readies
Rdy_StopFlow BOOL Output 0 1 = Ready for OCmd_StopFlow (enablesHMI button)
Rdy_CheckTol BOOL Output 0 1 = Ready for OCmd_CheckTol (enablesHMI button)
Rdy_Bump BOOL Output 0 1 = Ready for OCmd_Bump (enables HMIbutton)
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
IMPORTANT Mode Command Readies are provided by a P_Mode Instruction
embedded within the P_DoseWS Instruction. The P_ModeInstruction instance is named ‘Mode’.
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Mode.Rdy_Acq BOOL Output 0 1 = Ready for MCmd_Acq (enables HMIbutton)
Mode.Rdy_Rel BOOL Output 0 1 = Ready for MCmd_Rel (enables HMIbutton)
Mode.Rdy_AcqLock BOOL Output 0 1 = Ready for OCmd_AcqLock (enables
HMI button)
Mode.Rdy_Unlock BOOL Output 0 1 = Ready for OCmd_Unlock (enables HMIbutton)
IMPORTANT Alarm Command Readies are provided by P_Alarm Instructionsembedded within the P_DoseWS Instruction. Each P_AlarmInstruction instance is named for the alarm condition.
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
45/80
Publication SYSLIB-RM021C-EN-E - October 2011 33
Instruction Data Reference Chapter 3
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Rdy_Reset BOOL Output 0 1 = At least one Alarm requires Reset
Rdy_ResetAckAll BOOL Output 0 1 = At least one Alarm or latched Shedcondition requires Reset or Ack
OverTol.Rdy_Reset BOOL Output 0 1 = Ready for OverTol.OCmd_Reset(enables HMI button)
OverTol.Rdy_Ack BOOL Output 0 1 = Ready for OverTol.OCmd_Ack(enables HMI button)
OverTol.Rdy_Disable BOOL Output 0 1 = Ready for OverTol.OCmd_Disable(enables HMI button)
OverTol.Rdy_Enable BOOL Output 0 1 = Ready for OverTol.OCmd_Enable(enables HMI button)
UnderTol.Rdy_Reset BOOL Output 0 1 = Ready for UnderTol.OCmd_Reset
(enables HMI button)UnderTol.Rdy_Ack BOOL Output 0 1 = Ready for UnderTol.OCmd_Ack
(enables HMI button)
UnderTol.Rdy_Disable BOOL Output 0 1 = Ready for UnderTol.OCmd_Disable(enables HMI button)
UnderTol.Rdy_Enable BOOL Output 0 1 = Ready for UnderTol.OCmd_Enable(enables HMI button)
TareFault.Rdy_Reset BOOL Output 0 1 = Ready for TareFault.OCmd_Reset(enables HMI button)
TareFault.Rdy_Ack BOOL Output 0 1 = Ready for TareFault.OCmd_Ack(enables HMI button)
TareFault.Rdy_Disable BOOL Output 0 1 = Ready for TareFault.OCmd_Disable(enables HMI button)
TareFault.Rdy_Enable BOOL Output 0 1 = Ready for TareFault.OCmd_Enable(enables HMI button)
EqpFault.Rdy_Reset BOOL Output 0 1 = Ready for EqpFault.OCmd_Reset(enables HMI button)
EqpFault.Rdy_Ack BOOL Output 0 1 = Ready for EqpFault.OCmd_Ack(enables HMI button)
EqpFault.Rdy_Disable BOOL Output 0 1 = Ready for EqpFault.OCmd_Disable(enables HMI button)
EqpFault.Rdy_Enable BOOL Output 0 1 = Ready for EqpFault.OCmd_Enable
(enables HMI button)
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
46/80
34 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Values (Val_)
Value data elements contain process or device variables, the notification levelfor alarm animation, and the current accepted values of any thresholds orother settings (from Program or Operator Settings) for the P_DoseWSinstruction. The HMI displays these Values, and they are available for use byother application logic.
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Val_PV REAL Output 0.0 Float Weight on Scale (EU) • Cfg_InpRawMax
• Cfg_InpRawMin
• Cfg_PVEUMin
• Cfg_PVEUMin
• Cfg_SimStartWt
Val_Tare REAL Output 0.0 Float Weight on Scale when Tare
Command received (EU)
• Cfg_SimStartWt
Val_Qty REAL Output 0.0 Float Quantity actually delivered (change inweight) (EU)
• Cfg_HasDribble
• Cfg_LossInWeight
• Cfg_SimDribbleRate
• Cfg_SimRate
• Cfg_SimStartWt
Val_Rate REAL Output 0.0 Float Current Delivery Rate (EU/time) • Cfg_LossInWeight
• Cfg_RateFiltTC
• Cfg_RateTime
• Cfg_SimDribbleRate
• Cfg_SimRateVal_SP REAL Output 0.0 Float Amount to be delivered (Setpoint)
(EU)• Cfg_HasDribble
• Cfg_MaxQty
Val_Remain REAL Output 0.0 Float Amount yet to deliver to reachSetpoint (EU)
Val_PctComplete REAL Output 0.0 Float Percent Complete (for Progress Baron HMI) 0.0 to 100.0%
Val_DribbleQty REAL Output 0.0 Float Amount to be delivered at slow rate(EU)
• Cfg_HasDribble
Val_Preact REAL Output 0.0 Float Amount before SP at which flow willbe stopped (EU)
• Cfg_AutoAdjPct
• Cfg_AutoAdjPreact
• Cfg_HasDribble
Val_TolHi REAL Output 0.0 Float Allowed Amount > SP (EU)
Val_TolLo REAL Output 0.0 Float Allowed Amount < SP (EU)
Val_PVEUMin REAL Output 0.0 Float Minimum of scaled range = MIN(Cfg_PVEUMin, Cfg_PVEUMax)
Val_PVEUMax REAL Output 10000.0 Float Maximum of scaled range = MAX(Cfg_PVEUMin, Cfg_PVEUMax)
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
47/80
Publication SYSLIB-RM021C-EN-E - October 2011 35
Instruction Data Reference Chapter 3
Val_Cmd SINT Output 0 Decimal This shows the command beingprocessed, returns to zero once thecommand secedes or fails. May bemade not visible if zero. These valuesare also used for Inp_OvrCmd. 0 = None 1 = Tare Scale 3 = Start Delivery 4 = Start Dribble 5 = Bump 6 = Stop Delivery
Val_Fdbk SINT Output 0 Decimal This shows the (usually raw,uninterpreted) input from the device. 0 = None 1 = Stopped
2 = Delivering 3 = Dribbling
Val_Sts SINT Output 0 Decimal This is the PRIMARY STATUS, used toshow the operator the ‘confirmed’device status. 0 = Power Up / Reset1 = Stopped 3 = Delivering4 = Dribbling5 = Bumping6 = Start Delivery 7 = Start Dribble8 = Stopping
33 = DisabledVal_Fault SINT Output 0 Decimal This is the DEVICE FAULT STATUS,
used to show the operator the mostsevere device fault.0 = None 17 = Equipment Fault 34 = Configuration Error
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
48/80
36 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Status (Sts_)
Status data elements contain process or device states, Mode status and Alarmstatus. The HMI displays these Status points, and they are available for use byother application logic.
Device Status
Val_Mode SINT Output 0 Decimal This exists if P_Mode is used withinthe object and shows all modes usedby (implement in) the object.0 = No Mode 2 = Maintenance 3 = Override 4 = Program Lock 5 = Operator Lock 6 = Program (Operator Default) 7 = Operator (Program Default) 8 = Program (Program Default) 9 = Operator (Operator Default)
Val_Owner DINT Output 0 Decimal Current Object Owner ID (0=notowned)
Val_Notify SINT Output 0 Decimal Current Alarm Level andAcknowledgement (enumeration) 0 = No alarm 1 = Alarm cleared, not acknowledged 2 = Information alarm 3 = Unacknowledged Info. alarm 4 = Warning alarm 5 = Unacknowledged Warning alarm 6 = Exception alarm 7 = Unacknowledged Exception alarm 8 = Fault alarm 9 = Unacknowledged Fault alarm
•Cfg_EqpFaultSeverity
• Cfg_OverTolSeverity
• Cfg_TareFaultSeverity
• Cfg_UnderTolSeverity
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfiguration
ParameterSts_Tared BOOL Output 0 Scale Tare completed, Qty = 0.0
Sts_FlowStarting BOOL Output 0 1 = Flow is Starting (Out_Run is ON, Fdbknot showing Run)
Sts_FlowRunning BOOL Output 0 1 = Flow is Running (Out_Run is ON)
Sts_DribbleStarting BOOL Output 0 1 = Dribble Starting (Out_Dribble is ON,Fdbk not showing Dribble)
Sts_FlowDribble BOOL Output 0 1 = Flow is slowed to Dribble (Out_Dribbleis ON)
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
49/80
Publication SYSLIB-RM021C-EN-E - October 2011 37
Instruction Data Reference Chapter 3
Sts_FlowStopping BOOL Output 0 1 = Flow is Stopping (Out_Stop is ON,Fdbk not showing Stopped)
Sts_FlowStopped BOOL Output 0 1 = Flow is Stopped (Out_Stop is ON)
Sts_Bumping BOOL Output 0 1 = Bump flow is active
Sts_Complete BOOL Output 0 1 = Total Delivered > (SP - Preact)
Sts_InTol BOOL Output 0 1 = Total Delivered is Within Tolerances
Sts_Available BOOL Output 0 1 = Dosing available for control byautomation (Prog)
Sts_PVBad BOOL Output 0 1 = Weight PV and Rate PV Quality Bad(I/O fail)
0 = OK
Sts_PVUncertain BOOL Output 0 1 = Weight PV and Rate PV Quality isUncertain
0 = OK
Sts_NotRdy BOOL Output 0 1 = Device is Not Ready to be operated
Sts_MaintByp BOOL Output 0 1 = A Maintenance Bypass is Active,display icon
Sts_AlmInh BOOL Output 0 1 = One or more Alarms Inhibited,Disabled or Suppressed
Sts_Err BOOL Output 0 1 = Error: Bad Configuration, see detail Errbits for reason
Err_Raw BOOL Output 0 1 = Error: Cfg_InpRawMax =Cfg_InpRawMin invalid
Err_EU BOOL Output 0 1 = Error: Cfg_PVEUMax = Cfg_PVEUMin
Err_Rate BOOL Output 0 1 = Error: Cfg_RateFiltTC or Cfg_RateTimeinvalid
Err_Limit BOOL Output 0 1 = Error: Cfg_MaxQty invalid
Err_Sim BOOL Output 0 1 = Error: Cfg_SimDribbleRate orCfg_SetTrack invalid
Err_Timer BOOL Output 0 1 = Error: Cfg_BumpT (use 0.0 to2147483.647)
Err_Alarm BOOL Output 0 1 = Error: Alarm Minimum On Time orSeverity Cfg Invalid
Err_Keep BOOL Output 0 1 = Error in Config: Invalid setup ofCfg_OperKeep and Cfg_ProgKeep
Name: Data Type: Usage: Default: Style: Description:
AssociatedConfigurationParameter
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
50/80
38 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 3 Instruction Data Reference
Mode Status
Alarm Status
Name:
Data
Type: Usage: Default: Style: Description:
AssociatedConfiguration
Parameter
Sts_Maint BOOL Output 0 1 = Mode is Maintenance (supersedesOvrd, Prog, Oper)
Sts_Prog BOOL Output 0 1 = Mode is Program (auto)
Sts_Oper BOOL Output 1 1 = Mode is Operator (manual)
Sts_ProgOperLock BOOL Output 0 1 = Program or Operator has requestedMode Lock
Sts_NoMode BOOL Output 0 1 = NoMode (Disabled because EnableInis False)
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
Sts_OverTol BOOL Output 0 1 = Delivery Out of ToleranceHigh
Alm_OverTol BOOL Output 0 1 = Delivery Out of ToleranceHigh Alarm
• Cfg_AutoAdjPreact
• Cfg_OverTolResetReqd
• Cfg_HasOverTolAlmAck_OverTol BOOL Output 0 1 = Over Tolerance Alarm
Acknowledged• Cfg_OverTolAckReqd
• Cfg_HasOverTolAlm
Sts_OverTolDisabled BOOL Output 0 1 = Over Tolerance AlarmDisabled (will not be sent)
Sts_OverTolInhibited BOOL Output 0 1 = Over Tolerance AlarmInhibited by logic
Sts_OverTolSuppressed BOOL Output 0 1 = Over Tolerance AlarmSuppressed (logged only)
Sts_UnderTol BOOL Output 0 1 = Delivery Out of ToleranceLow
Alm_UnderTol BOOL Output 0 1 = Delivery Out of ToleranceLow Alarm
• Cfg_AutoAdjPreact
• Cfg_UnderTolResetReqd
• Cfg_HasUnderTolAlm
Ack_UnderTol BOOL Output 0 1 = Under Tolerance AlarmAcknowledged
• Cfg_UnderTolAckReqd
• Cfg_HasUnderTolAlm
Sts_UnderTolDisabled BOOL Output 0 1 = Under Tolerance AlarmDisabled (will not be sent)
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
51/80
Publication SYSLIB-RM021C-EN-E - October 2011 39
Instruction Data Reference Chapter 3
Sts_UnderTolInhibited BOOL Output 0 1 = Under Tolerance AlarmInhibited by logic
Sts_UnderTolSuppressed BOOL Output 0 1 = Under Tolerance AlarmSuppressed (logged only)
Sts_TareFault BOOL Output 0 1 = Scale reading movedunexpectedly since Tare
Alm_TareFault BOOL Output 0 1 = Warning: Scale readingmoved since Tare
• Cfg_HasTareFaultAlm
• Cfg_TareFaultResetReqd
Ack_TareFault BOOL Output 0 1 = Tare Fault AlarmAcknowledged
• Cfg_HasTareFaultAlm
• Cfg_TareFaultAckReqd
Sts_TareFaultDisabled BOOL Output 0 1 = Tare Fault Alarm Disabled(not saved or sent)
Sts_TareFaultInhibited BOOL Output 0 1 = Tare Fault Alarm Inhibitedby logic
Sts_TareFaultSuppressed‘ BOOL Output 0 1 = Tare Fault AlarmSuppressed (logged only)
Sts_EqpFault BOOL Output 0 1 = Equipment Fault Detected
Alm_EqpFault BOOL Output 0 1 = Alarm: Equipment Fault(sensor or controlledequipment)
• Cfg_HasEqpFaultAlm
• Cfg_EqpFaultResetReqd
Ack_EqpFault BOOL Output 0 1 = Equipment Fault AlarmAcknowledged
• Cfg_HasEqpFaultAlm
• Cfg_EqpFaultAckReqd
Sts_EqpFaultDisabled BOOL Output 0 1 = Equipment Fault AlarmDisabled (will not be sent)
Sts_EqpFaultInhibited BOOL Output 0 1 = Equipment Fault AlarmInhibited by logic
Sts_EqpFaultSuppressed BOOL Output 0 1 = Equipment Fault AlarmSuppressed (logged only)
Name:DataType: Usage: Default: Style: Description:
AssociatedConfigurationParameter
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
52/80
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
53/80
41Publication SYSLIB-RM021C-EN-E - October 2011 41
Chapter 4
HMI Reference
This chapter describes the HMI Graphic Objects and Faceplates provided forthe Operator interface for the P_DoseWS Instruction.
Graphic Objects Graphic Objects are provided for use on end-user process graphic displays. Weigh Scale Dosing Graphic Objects have the following common attributes:
Each Weigh Scale Dosing Graphic Symbol displays the object’s label andengineering units text, the current value of the scale weight and quantitydelivered in this dosing, and various status indicators. The current values of thequantity and weight change color depending on the input signal quality. Thegraphic symbol has a color changing alarm border that blinks onunacknowledged alarm.
The overall Graphic Symbol includes a touch field over it which calls up theobject’s Faceplate. In addition, pausing the pointing device over the GraphicSymbol displays a tooltip showing the object’s configured Tag and Description.
Progress Bar (Percent
Complete)
Status / Quality
Indicator
Quantity Value
Label
Current Scale Weight Value
Alarm Indicator
Delivered Quantity and Current Scale Weight
Engineering Units Text
Scale Symbol
Mode Indicator
State Indicator Text
Maintenance Bypass
Indicator
Alarm Border
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
54/80
42 Publication SYSLIB-RM021C-EN-E - October 2011
Chapter 4 HMI Reference
Graphic Representation
The Weight Value and Quantity Value displays change color based on the
highest severity alarm currently active.
The color of the Weigh Scale symbol and its state text change depending on
the commanded state of the controlled equipment:
Status / Quality Indicators
One of these symbols appears to the left of the Weight Value when thedescribed condition is true
TIP
When the Invalid Configuration Indicator appears, you can find whatconfiguration setting is invalid by following the indicators like a ’trail ofbreadcrumbs’. Click the Graphic Symbol to call up the Faceplate. The InvalidConfiguration indicator will appear next to the appropriate tab at the top of theFaceplate to guide you in finding the configuration error. Once you navigate to thetab, the misconfigured item will be flagged with this indicator or appear in amagenta box.
Color Alarm Severity
Light Blue Information Alarm
Yellow Warning Alarm
Red Exception Alarm
Magenta Fault Alarm
Green No active alarms
Color Flowmeter State
Gray No Flow (stopped)
Dark Green Running
Blue Dribble
Light Yellow Bumping
Graphic Symbol Description
Invalid Configuration
Weight Input Quality Bad (’stale’)
Weight Input Quality Uncertain
No symbol displayed Weight Input Quality Good and no InvalidConfiguration entries
-
8/20/2019 P DoseWS 2.0 Syslib-rm021 -En-e
55/80
Publication SYSLIB-RM021C-EN-E - October 2011 43
HMI Reference Chapter 4
For the Weigh Scale Dosing Instruction, the Invalid Configuration Indicatorappears under any of the following conditions:
• The Input Raw Minimum scaling value is equal to the Input RawMaximum scaling value.
• The Input Engineering Unit Minimum scaling value is equal to theInput Engineering Unit Maximum scaling value.
• The Tare Fault thresh