p dosefm 2.0 syslib-rm020

88

Click here to load reader

Upload: carbono980

Post on 16-Jul-2016

29 views

Category:

Documents


6 download

DESCRIPTION

P DoseFM 2.0 Syslib-rm020 -En-e

TRANSCRIPT

Page 1: P DoseFM 2.0 Syslib-rm020

Process Add-On Instructions and Graphics: Flowmeter Dosing (P_DoseFM)

Reference Manual

Compatible with the Plant-wide Integrated Architecture™

Page 2: P DoseFM 2.0 Syslib-rm020

Important User InformationSolid state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Appli-

cation, Installation and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office

or 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 re-

sponsible for applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.

In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application

of this equipment.

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements 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 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.

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.

WARNINGIdentifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to personal injury or death, property damage, or economic loss.

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

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.

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.

Page 3: P DoseFM 2.0 Syslib-rm020

Summary of Changes

Introduction This release of this document is updated throughout version 2.0 of the Flowmeter Dosing (P_DoseFM) Add-On Instruction and Graphics. Please refer 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

iiiPublication SYSLIB-RM020C-EN-E - October 2011 iii

Page 4: P DoseFM 2.0 Syslib-rm020

Summary of Changes

Notes:

iv Publication SYSLIB-RM020C-EN-E - October 2011

Page 5: P DoseFM 2.0 Syslib-rm020

Table of ContentsPreface Use of this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Conventions and Related Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiSet and Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiEdge and Level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiiRelay Ladder Rung Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixPre-Scan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xFunction Block States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiEntering Text in FactoryTalk View SE. . . . . . . . . . . . . . . . . . . . . . xii

Chapter 1Overview Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Primary Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Revision Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 2Configuration Options Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 3Instruction Data Reference Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Inputs (Inp_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Outputs (Out_). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Configurations (Cfg_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Program Settings (PSet_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Program Commands (PCmd_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Device Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Mode Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Alarm Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Operator Settings, Maintenance Settings, Other Settings (OSet_, MSet_, Set_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Operator / Maintenance Setting Readies . . . . . . . . . . . . . . . . . . . . 30Operator Commands, Maintenance Commands, Command Readies (OCmd_, MCmd_, Rdy_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Device Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Mode Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Alarm Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Device Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Mode Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Alarm Command Readies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Values (Val_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Status (Sts_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Device Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Mode Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Alarm Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

vPublication SYSLIB-RM020C-EN-E - October 2011 v

Page 6: P DoseFM 2.0 Syslib-rm020

Table of Contents

Chapter 4HMI Reference Graphic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Graphic Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Mode Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Using Graphics Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Alarms Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Trends Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Alarm Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Flowmeter Dosing Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . 73

vi Publication SYSLIB-RM020C-EN-E - October 2011

Page 7: P DoseFM 2.0 Syslib-rm020

Preface

Use of this Document This document provides a programmer with details on the P_DoseFM instruction for a Logix-based controller. You should already be familiar with how the Logix-based controller stores and processes data.

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

Conventions and Related Terms

Set and Clear

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

This term: 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

viiPublication SYSLIB-RM020C-EN-E - October 2011 vii

Page 8: P DoseFM 2.0 Syslib-rm020

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 the action; 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 a state, usually 1)

• Opposite action ("disable") is triggered by input being in opposite 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 Level input on the instruction (one-to-one relationship restriction).

IMPORTANT All Operator Commands (OCmd_) and Maintenance Commands (MCmd_) are Edge triggered. The HMI graphic object or Faceplate SETS (writes a 1 to) each Command bit and the Instruction CLEARS (writes a 0 to) the Command bit, then performs the function, if possible.

viii Publication SYSLIB-RM020C-EN-E - October 2011

Page 9: P DoseFM 2.0 Syslib-rm020

Preface

Relay Ladder Rung Condition

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

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

IMPORTANT This instruction has Program Commands (PCmd_) which are selectable as Edge or Level, depending on the Configuration Parameter 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 the Instruction Data Reference become Level triggered, and opposite functions are triggered by the primary Program Command being CLEARED to 0.

IMPORTANT The rung-in condition is reflected in the EnableIn parameter and determines how the system performs each Process Add-On Instruction. If the EnableIn signal is TRUE, the system performs the instruction’s main logic routine. Conversely, if the EnableIn signal is FALSE, the system performs the instruction’s EnableInFalse routine.

The instruction’s main logic routine sets/clears the EnableOut parameter, which then determines the rung-out condition. The EnableInFalse routine cannot set the EnableOut parameter. If the rung-in condition is FALSE, then the EnableOut parameter and the rung-out condition will also be FALSE.

Publication SYSLIB-RM020C-EN-E - October 2011 ix

Page 10: P DoseFM 2.0 Syslib-rm020

Preface

Pre-Scan

During the transition into RUN, the controller performs a Pre-scan before the first 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 ignores jumps that could skip the execution of instructions. The controller executes all FOR loops and subroutine calls. If a subroutine is called more than once, it is executed each time it is called. The controller uses Pre-scan instructions to reset non-retentive data values.

During Pre-scan, input values are not current and outputs are not written. The following 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’s logic routine as all FALSE and then performs its Pre-scan routine as TRUE.

x Publication SYSLIB-RM020C-EN-E - October 2011

Page 11: P DoseFM 2.0 Syslib-rm020

Preface

Function Block States

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

Every function block instruction also includes EnableIn and EnableOut parameters.

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

Possible Condition: Description:

Pre-scan Pre-scan for function block routines is the same as for relay ladder routines. The only difference is that the Enableln parameter for each function block instruction is cleared during Pre-scan.

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

Instruction first run Instruction first run refers to the first time the instruction executes with a new instance of a data structure. The controller uses instruction first run to generate coefficients and other data stores that do not change for a function block after initial download.

IMPORTANT When programming in function block, restrict the range

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

single precision floating point (±10±38).

Publication SYSLIB-RM020C-EN-E - October 2011 xi

Page 12: P DoseFM 2.0 Syslib-rm020

Preface

Entering Text in FactoryTalk View SE

When entering data into String Input fields in FactoryTalk View SE, the data is not 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

xii Publication SYSLIB-RM020C-EN-E - October 2011

Page 13: P DoseFM 2.0 Syslib-rm020

Chapter 1

Overview

The P_DoseFM (Dosing with Flowmeter) Add-On Instruction controls an ingredient addition which uses a flowmeter to measure the amount of ingredient added. The flowmeter may be an analog flowmeter (signal proportional to flow), a pulse generating flowmeter (pulse count proportional to quantity delivered) or a digital flowmeter providing flow rate or quantity (totalized flow) information.

Use when:

• You want to control basic dosing (ingredient addition) with basic features such as bulk/dribble rate selection, Preact, automatic Preact adjustment, and the ability to start, pause and resume flow.

• You are measuring the amount of ingredient added using a flowmeter. The flowmeter can provide an analog flow rate, an analog quantity (total) or a pulse count with rollover. This instruction is designed to work well with high-speed counting input cards such as the 1756-HSC (High Speed Counter) module or the 1756-CFM (Configurable Flow Meter) module.

Do NOT use when:

• You are transferring material using a weigh scale to measure the amount of material before and after transfer. Use the P_DoseWS (Dosing with Weigh Scale) Instruction instead.

• You need to control precision blending. This instruction does not include 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 instruction instead.

You may need additional logic when:

• You need more complicated sequencing, including special actions when restarting, aborting or holding an addition. This sort of sequencing is a good candidate for an Equipment Phase. Equipment Phase logic can drive the P_DoseFM instruction using its Program Mode commands and settings.

• The equipment requires complicated startup and shutdown logic. You can provide this logic separately and use the P_DoseFM outputs to trigger the startup and shutdown of ingredient delivery.

1Publication SYSLIB-RM020C-EN-E - October 2011 1

Page 14: P DoseFM 2.0 Syslib-rm020

Chapter 1 Overview

Functional Description A typical sequence of Operator Commands and Settings and subsequent Instruction actions using the P_DoseFM instruction to perform ingredient dosing in Operator Mode is depicted in the following figure:

2 Publication SYSLIB-RM020C-EN-E - October 2011

Page 15: P DoseFM 2.0 Syslib-rm020

Overview Chapter 1

Primary Operations The primary operations of the P_DoseFM Instruction are:

• Provides Inputs for Rate (flow rate, quantity per time) and Quantity (total or pulse count).

• Provides the ability to use a pulse count as the Quantity PV, with configurable rollover count.

• Provides the ability to totalize the flow Rate PV to determine the Quantity delivered when the flowmeter provides a Rate signal but no Quantity. Provides scaling of the Rate analog input from Raw (input card) to Engineering (display) Units. Reverse scaling (max less than min) is supported.

• Provides the ability to calculate the flow Rate given the Quantity by differentiating with respect to time when the meter provides a total or pulse count but no Rate. If the Rate PV is calculated from an input Quantity, the P_DoseFM instruction uses a first-order (lag) filter on the calculated Rate PV signal to reduce the impact of jitter, scan time, quantization error, or input signal noise.

• Provides a Low Rate Cutoff function, used to ignore flow rate values near zero to deal with noise or zero calibration error in the rate signal.

• Provides the ability to use a flowmeter with built-in totalizer. Forwards the totalizer Clear command to the flowmeter and checks that the flowmeter's total was reset. Once the total is cleared, the instruction checks for ‘unrequested’ flow, that is, increase in the delivered total before flow is actually started, and raises a Zero Fault if such flow occurs.

• Provides outputs to control associated equipment (pumps, valves, etc.) to start and stop flow. The Operator or the Program may start the ingredient addition, then pause and resume it if needed.

• Monitors the status of controlled equipment (pumps, valves, etc.). Flow is stopped and an alarm is raised on an equipment fault or if the equipment fails to respond as commanded.

• Monitors Rate and/or Quantity Input communication status and provides indication of Uncertain or Bad Rate PV or Quantity PV. Flow is stopped and an 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 complete during delivery.

Publication SYSLIB-RM020C-EN-E - October 2011 3

Page 16: P DoseFM 2.0 Syslib-rm020

Chapter 1 Overview

• Provides Program or Operator entry of High and Low Tolerance limits. Allows the Program or Operator to initiate a Tolerance Check after delivery is complete. Provides a warning if under tolerance and allows the Operator to ‘bump’ the flow to make up the shortage. The bump can 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 rate as the quantity delivered approaches setpoint. Provides Operator or Program 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 the pipe, time for 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 allows the Preact to ‘learn’ the correct value over time.

• Uses the standard Mode (P_Mode) Instruction to provide Mode (ownership) for entry of settings and acceptance of commands. See the Operating Modes section for more information.

4 Publication SYSLIB-RM020C-EN-E - October 2011

Page 17: P DoseFM 2.0 Syslib-rm020

Overview Chapter 1

Operating Modes The P_DoseFM Instruction uses the following standard Modes, implemented using an embedded P_Mode Add-On Instruction:

The Hand and Override (Ovrd) Modes are not used. (These Modes are typically used by the controlled equipment.)

Refer to the Process Add-On Instructions and Graphics: Mode (P_Mode) Reference Manual, publication SYSLIB-RM005, for more information.

Alarms The P_DoseFM Instruction uses the following alarms, implemented using embedded 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.

Mode Description

Operator 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 addition stops at the Preact.

Program Program logic can set the Setpoint, Preact, Dribble Quantity, and High and Low Tolerances. Program logic can clear, start and stop the totalizer, start and stop (pause) ingredient flow and initiate the tolerance check. The Operator can still bump flow if needed after addition stops at the Preact.

Maintenance Identical to Operator Mode, except for Mode priority rules:

• Program cannot acquire away from Maintenance, but Program can acquire away from Operator if Operator Mode is not locked.

• Operator cannot acquire away from Program if Program Mode is locked, but Maintenance can acquire away from Program at any time.

Alarm Description

Over Tolerance Raised when Tolerance Check is performed if the quantity delivered exceeds the setpoint by more than the high tolerance limit.

Under Tolerance (warning)

Raised when the Tolerance check is performed if the quantity delivered falls short of the setpoint by more than the low tolerance limit.

Equipment Fault Raised if the controlled equipment asserts the Inp_CtrldEqpFault input or if the equipment feedback signals fail to track the commanded state of the equipment. If configured as a shed fault, this also stops flow if it is running.

Zero Fault Raised if the scale is tared and then drifts away from the tare weight before the start flow command is received.

Publication SYSLIB-RM020C-EN-E - October 2011 5

Page 18: P DoseFM 2.0 Syslib-rm020

Chapter 1 Overview

Execution

Refer to the Logix5000 Controllers Add-On Instructions Programming Manual, publication 1756-PM010, for more information on Add-On Instruction execution condition handling.

Condition Description

EnableIn False (False Rung) Any commands received are discarded. All alarms are cleared. The Mode is reported as "NO MODE". The displayed rate is zeroed. Outputs to controlled equipment are de-energized. Other output parameters (Values and Status) hold their last value.

Powerup (Pre-Scan, First Scan) Any Commands received before First Scan are discarded.

Embedded P_Alarm instructions are handled in accordance with their standard powerup procedures. Refer to the Reference Manual for the P_Alarm Instructions for more information.

Postscan (SFC Transition) No SFC Postscan logic is provided.

6 Publication SYSLIB-RM020C-EN-E - October 2011

Page 19: P DoseFM 2.0 Syslib-rm020

Overview Chapter 1

Revision Compatibility The P_DoseFM Add-On Instruction in RSLogix 5000 software and the Faceplate in FactoryTalk View software are marked with revision information as shown in the following table:.

The Instruction and Faceplate are compatible if they have the same Major and Minor Revision numbers.

The Major Revision is the first number, before the period.

The Minor Revision is the second number, after the period and before the hyphen or space.

Information after the hyphen or space indicates the Tweak Revision. The Instruction and Faceplate do not have to have the same Tweak Revision to be compatible.

In the table above, the Add-On Instruction and Faceplate shown are compatible because they have the same Major.Minor (1.1).

Component Example

The Add-On Instruction in RSLogix 5000 has revision information visible when the instruction is selected in the Controller Organizer.

The Faceplate in FactoryTalk View has revision information visible when the pointer is paused just inside the lower left-hand corner of the Faceplate when called up on a running HMI Client.

Publication SYSLIB-RM020C-EN-E - October 2011 7

Page 20: P DoseFM 2.0 Syslib-rm020

Chapter 1 Overview

Notes:

8 Publication SYSLIB-RM020C-EN-E - October 2011

Page 21: P DoseFM 2.0 Syslib-rm020

Chapter 2

Configuration Options

Configuration Parameters Enter the appropriate values from the following table into the P_DoseFM Instruction’s configuration parameters to configure it for your application.

Use the HMI Faceplate or RSLogix 5000 Tag Monitor function to set the applicable configuration parameter(s).

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

Cfg_Desc

Cfg_Label

Cfg_QtyEU

Cfg_RateEU

Cfg_Tag

’Dosing with Flowmeter’

’Flowmeter Dosing’

’kg’

’kg/sec’

’P_DoseFM’

Engineering These Local Tags determine the text displayed on the various graphic objects and Faceplates for:

• Description

• Label (if used)

• Quantity Engineering Units

• Rate Engineering Units

• Tagname

Cfg_AutoAdjPct 10.0% Maintenance The Auto Adjust Percentage determines what percentage of the delivery error (setpoint minus quantity) is applied when automatically adjusting the Preact.

IMPORTANT This Configuration is limited by the instruction to a range of 0.0 to 100.0 percent.

• Cfg_AutoAdjPreact

• OSet_Preact

• PSet_Preact

• Val_Preact

9Publication SYSLIB-RM020C-EN-E - October 2011 9

Page 22: P DoseFM 2.0 Syslib-rm020

Chapter 2 Configuration Options

Cfg_AutoAdjPreact OFF Maintenance When this parameter is:

• ON, the Preact is automatically adjusted the first time a Tolerance Check is performed after a delivery and the delivery is In Tolerance.

• OFF, the Preact is not automatically adjusted.

IMPORTANT If a Bump is performed after a delivery, or the delivery is out of tolerance, the adjustment is NOT performed regardless of this configuration, in order to avoid applying an inappropriate adjustment.

• Alm_OverTol

• Alm_UnderTol

• Cfg_AutoAdjPct

• OCmd_Bump

• OCmd_CheckTol

• OSet_Preact

• PCmd_CheckTol

• PSet_Preact

• Val_Preact

Cfg_BumpT 0.0 sec Maintenance The Bump Time determines how long (in seconds) flow is delivered each time an OCmd_Bump is received.

If the Bump Time is set to 0.0, the bump function works like a jog, running the equipment as long as the bump command (OCmd_Bump) is asserted.

If Dribble is enabled (Cfg_HasDribble), the bump flow energizes the Out_DribbleFlow output; otherwise, it energizes the Out_RunFlow output.

IMPORTANT The Delivery Quantity must be below the Setpoint but more than the Setpoint minus the Preact for the Bump function to be available.

• OCmd_Bump

• Out_RunFlow

• Out_DribbleFlow

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

10 Publication SYSLIB-RM020C-EN-E - October 2011

Page 23: P DoseFM 2.0 Syslib-rm020

Configuration Options Chapter 2

Cfg_CalcQty OFF Engineering Set this bit if there is no signal to Inp_Qty; the instruction will calculate the quantity by integrating (totalizing) the Rate Input with respect to time. This configuration is used with analog flowmeters.

Clear this bit if there is a quantity or pulse count signal to Inp_Qty; the instruction will use the input value. This configuration is used with pulse flowmeters (with the 1756-CFM or 1756-HSC card) or with fieldbus meters that report a quantity (have a built-in totalizer).

• Inp_QtyPV

• Inp_RatePV

• Val_Qty

Cfg_CalcRate OFF Engineering Set this bit if there is no signal to Inp_Rate; the instruction will calculate the rate by differentiating the Quantity Input with respect to time. This configuration is used with pulse count flowmeters or other meters that report a quantity but no rate.

Clear this bit if there is a flow rate or pulse rate signal to Inp_Rate; the instruction will use the input value. This configuration is used with analog flowmeters, pulse flowmeters with the 1756-CFM or 1756-HSC card (which provide a rate signal), or with fieldbus meters that report a flow rate.

• Inp_QtyPV

• Inp_RatePV

• Val_Rate

Cfg_ClearPulseT 1 Maintenance Time to pulse Out_Clear to clear external totalizer (sec)

• Inp_RunFdbk

• Inp_DribbleFdbk

• Inp_StopFdbk

• Sts_EqpFault

• Alm_EqpFault

• Cfg_HasEqpFdbk

• Cfg_UseEqpFdbk

Cfg_FaultT 10 Maintenance Time for Equipment Feedback to follow Output before Fault (sec)

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

Publication SYSLIB-RM020C-EN-E - October 2011 11

Page 24: P DoseFM 2.0 Syslib-rm020

Chapter 2 Configuration Options

Cfg_CountsPerEU 1.0 Engineering This parameter determines the pulse count on Inp_Qty that equals one Engineering Unit of transferred material. For example, if a pulse-type flowmeter issues 50 pulses per kilogram of material transferred, set this parameter to 50.0.

This parameter is used with the 1756-CFM or 1756-HSC to convert the pulse count captured by the module into a quantity.

• Cfg_EUQtyMult

• Cfg_Rollover

• Inp_QtyPV

• Val_Qty

Cfg_EqpFaultAckReqd ON Alarm Configuration

When this parameter is:

• ON, the Acknowledge (Ack) bit is cleared when an alarm occurs, indicating an unacknowledged alarm. An Acknowledge Command is required to acknowledge the alarm (set the Ack bit).

• OFF, the Acknowledge (Ack) bit is set when an alarm occurs, indicating an acknowledged alarm. No Acknowledge Command is required.

• Ack_EqpFault

• EqpFault.OCmd_Ack

• Ack_OverTol

• PCmd_OverTolAck

• OverTol.OCmd_Ack

• Ack_UnderTol

• PCmd_UnderTolAck

• UnderTol.OCmd_Ack

• Ack_ZeroFault

• PCmd_ZeroFaultAck

• ZeroFault.OCmd_Ack

Cfg_OverTolAckReqd ON

Cfg_UnderTolAckReqd ON

Cfg_ZeroFaultAckReqd ON

Cfg_EqpFaultResetReqd OFF Alarm Configuration

When this parameter is:

• ON, each Dosing Alarm is latched”, and the instruction requires a Reset after the condition returns to normal in order to clear the Alarm

• OFF, the alarm clears when the condition returns to normal; no Reset is needed.

IMPORTANT The Over Tolerance and Under Tolerance Alarms are maintained until a new tolerance check is performed or an Alarm Reset is received. If the ResetReqd Configuration bit is set, these Alarms are maintained until an Alarm Reset is received.

• Inp_Reset

• Alm_EqpFault

• EqpFault.OCmd_Reset

• Alm_OverTol

• OverTol.OCmd_Reset

• Alm_UnderTol

• UnderTol.OCmd_Reset

• Alm_ZeroFault

• ZeroFault.OCmd_Reset

Cfg_OverTolResetReqd OFF

Cfg_UnderTolResetReqd OFF

Cfg_ZeroFaultResetReqd OFF

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

12 Publication SYSLIB-RM020C-EN-E - October 2011

Page 25: P DoseFM 2.0 Syslib-rm020

Configuration Options Chapter 2

Cfg_EqpFaultSeverity 4 Alarm Configuration

These parameters determine the Severity of each alarm, and thus the color of alarm animations for each alarm.

Valid values are:

• 1 = Information (blue)

• 2 = Warning (yellow)

• 3 = Exception (red)

• 4 = Fault (magenta)

• Val_Notify

Cfg_OverTolSeverity 3

Cfg_UnderTolSeverity 2

Cfg_ZeroFaultSeverity 4

Cfg_EUQtyMult 1.0 Engineering This parameter is used when integrating Inp_Rate to determine the Quantity of material transferred. The amount of material transferred is multiplied by this parameter as it is integrated. Use this parameter to convert the units of measure of the Rate input into the units of measure of the Quantity.

EXAMPLE If the meter reports Gallons per Minute but the transfer quantity is in Barrels, enter in this parameter the number of Barrels per Gallon. The totalized Gallons will be multiplied by this value to yield a Quantity in Barrels.

• Cfg_CalcQty

• Cfg_RateTime

• Inp_RatePV

• Val_Qty

Cfg_HasDribble OFF Engineering Set this parameter to:

• ON if you want the controlled equipment to slow to a reduced “dribble” or “trickle” rate when the quantity delivered approaches the setpoint. Out_RunFlow will be de-energized and Out_DribbleFlow will be energized when the quantity delivered is less than the setpoint by (Val_DribbleQty + Val_Preact).

• OFF if the controlled equipment cannot be slowed to a reduced delivery rate or you do not want to slow delivery as the delivered quantity approaches setpoint.

• Out_RunFlow

• Out_DribbleFlow

• OSet_DribbleQty

• PSet_DribbleQty

• Val_DribbleQty

• Val_Preact

• Val_Qty

• Val_SP

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

Publication SYSLIB-RM020C-EN-E - October 2011 13

Page 26: P DoseFM 2.0 Syslib-rm020

Chapter 2 Configuration Options

Cfg_HasEqpFdbk OFF Engineering Set this parameter:

• ON if the controlled equipment provides feedback signals and the signals are connected to Inp_RunFdbk, Inp7_DribbleFdbk and Inp_StopFdbk.

• OFF if the controlled equipment has no feedback to this instruction. The instruction will simulate the equipment status.

This configuration identified whether the equipment feedbacks exist. Cfg_UseEqpFdbk determines whether the feedbacks are actually used.

• Inp_RunFdbk

• Inp_DribbleFdbk

• Inp_StopFdbk

• Sts_EqpFault

• Alm_EqpFault

• Cfg_FaultT

Cfg_UseEqpFdbk OFF Maintenance This parameter is typically used on a temporary basis by Maintenance. Set this parameter:

• ON if the equipment feedback signals connected to Inp_RunFdbk, Inp_DribbleFdbk and Inp_StopFdbk should be used for equipment failure checking.

• OFF to disable feedback checking and the Equipment Fail alarm. The instruction will simulate the equipment feedback.

This configuration identifies whether the equipment feedbacks should be used. Cfg_HasEqpFdbk determines whether the feedbacks exist. If the feedbacks do not exist (Cfg_HasEqpFdbk = 0), this parameter is forced to OFF.

• Inp_RunFdbk

• Inp_DribbleFdbk

• Inp_StopFdbk

• Sts_EqpFault

• Alm_EqpFault

• Cfg_FaultT

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

14 Publication SYSLIB-RM020C-EN-E - October 2011

Page 27: P DoseFM 2.0 Syslib-rm020

Configuration Options Chapter 2

Cfg_HasEqpFaultAlm OFF Alarm Configuration

These parameters determine whether the corresponding alarm exists and will be checked for, or doesn’t exist and will not be used.

When this parameter is:

• ON, the Alarm exists and will be checked

• OFF, the Alarm does not exist and will not be used

Cfg_HasOverTolAlm OFF

Cfg_HasUnderTolAlm OFF

Cfg_HasZeroFaultAlm OFF

Cfg_LoRateCutoff 0.0 Maintenance When the Inp_RatePV Input is being totalized to calculate the quantity transferred, a flow rate below the Low Rate Cutoff will be ignored (not totalized).

This parameter is intended to help the totalizer ignore flow transmitter zero error or noise on the transmitted flow signal when flow is stopped.

• Cfg_CalcQty

• Cfg_RateFiltTC

• Inp_RatePV

• Val_Qty

Cfg_MaxQty 1.5E+38 Maintenance This parameter determines the maximum allowed quantity to deliver. Val_SP is limited to be less than or equal to Cfg_MaxQty.

• OSet_SP

• PSet_SP

• Val_SP

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

Publication SYSLIB-RM020C-EN-E - October 2011 15

Page 28: P DoseFM 2.0 Syslib-rm020

Chapter 2 Configuration Options

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 / Clear totalizer, Start / Stop flow, Check Tolerance)Bit .1: Delivery SetpointBit .2: Dribble and Preact quantitiesBit .3: Tolerances

TIPTIP

A function cannot be reserved for Operator using Cfg_OperKeep and also be reserved for Program using Cfg_ProgKeep. And at least one function must be ’not kept’ (remain under control of the Instruction Mode).

• OCmd_ClearTot

• OCmd_StartTot

• OCmd_StopTot

• OCmd_StartFlow

• OCmd_StopFlow

• OCmd_CheckTol

• OCmd_Bump

• OSet_SP

• OSet_DribbleQty

• OSet_Preact

• OSet_TolHi

• OSet_TolLo

• Err_Keep

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

16 Publication SYSLIB-RM020C-EN-E - October 2011

Page 29: P DoseFM 2.0 Syslib-rm020

Configuration Options Chapter 2

Cfg_ProgKeep 2#0000_0000 Engineering Set bits within this 8-bit integer to select functions to keep under Program control even when this instruction is in Operator Mode. Clear bits to leave the corresponding functions under control of the instruction Mode.

Bit .0: Operating Commands (Start / Stop / Clear totalizer, Start / Stop flow, Check tolerance) Bit .1: Delivery Setpoint Bit .2: Dribble and Preact quantities Bit .3: Tolerances

TIPTIP A function cannot be reserved for Operator using Cfg_ProgKeep. And at least one function must be ’not kept’ (remain under control of the instruction Mode).

• PCmd_ClearTot

• PCmd_StartTot

• PCmd_StopTot

• 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-triggered Program Commands.

• OFF to use Level-triggered Program Commands.

See the Edge and Level section in the Preface for more information.

The Cfg_PCmdClear parameter configures all Program Commands (PCmd_) for either Level or Edge triggering.

Cfg_ProgDefault OFF When this parameter is:

• ON, the Mode defaults to Program if no Mode is being requested.

• OFF, the Mode defaults to Operator if no Mode is being requested.

IMPORTANT Changing this parameter online may cause unintended mode changes.

• Val_Mode

• Sts_Prog

• Sts_Oper

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

Publication SYSLIB-RM020C-EN-E - October 2011 17

Page 30: P DoseFM 2.0 Syslib-rm020

Chapter 2 Configuration Options

Cfg_ShedOnEqpFault OFF When this parameter is:

• ON, if an equipment fault is detected, an equipment fault status and alarm are raised, the flow is stopped, and a reset is required to restart flow.

• OFF, if an equipment fault is detected, only the equipment fault status and alarm are raised. The instruction does not change the state of the flow.

Cfg_RateFiltTC 0.1 sec Maintenance Set this parameter to the Time Constant to be used in filtering the Val_Rate signal generated when calculating rate from the Inp_QtyPV quantity input.

The filter helps eliminate jitter in the calculated rate caused by uneven and/or asynchronous I/O updates and program scans. Increasing the Time Constant removes more noise from the signal but makes its response slower. A value of 0.0 disables the filter and the instantaneous quantity rate-of-change is reported.

• Cfg_CalcRate

• Inp_QtyPV

• Val_Rate

Cfg_RateTime 1.0 sec Engineering This parameter is the time base for the rate to quantity integrator (totalizer) and the quantity to rate differentator (rate of change). Enter the number of seconds in the denominator (“per”) of the rate units of measure. For example, if the flow is in Gallons per Minute, enter 60.0 (seconds in a minute). If the flow is in Barrels per Day, enter 86400.0 (seconds in a day).

• Cfg_CalcQty

• Cfg_CalcRate

• Inp_QtyPV

• Inp_RatePV

• Val_Qty

• Val_Rate

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

18 Publication SYSLIB-RM020C-EN-E - October 2011

Page 31: P DoseFM 2.0 Syslib-rm020

Configuration Options Chapter 2

Cfg_Rollover 0.0 counts Engineering If a pulse count is connected to the quantity Input (Inp_QtyPV), enter the maximum pulse count, the number at which the pulse count wraps around to zero. For example, if you use the 1756-CFM module and configure the input channel to provide a pulse count of 0 to 999,999 then set this parameter to 999999.0.

IMPORTANT This value contains the highest pulse count value that will be received (999,999), not the number of pulses (1,000,000) to rollover.

IMPORTANT The Inp_QtyPV Input parameter is a real number (REAL), not an integer (DINT), to support meters that provide a total instead of a pulse count. A REAL parameter cannot exactly represent integers larger than about 8,000,000 (23-bit mantissa). Avoid using a rollover point larger than about 4,000,000. (approximately 2^22).

• Cfg_CountsPerEU

• Inp_QtyPV

• Val_Qty

Cfg_SetTrack ON Maintenance When this parameter is:

• ON, the Operator Settings track the Program Settings when the Mode is Program, and Program Settings track the Operator Settings when the Mode is Operator. Transition between Modes is bumpless.

• OFF, the Operator Settings and Program Settings are not modified by this instruction and retain their values regardless of Program or Operator Mode. When the mode is changed, the value of the output may bump, say from the Program-set value to the Operator-set value.

• OSet_DribbleQty

• OSet_Preact

• OSet_SP

• OSet_TolHi

• OSet_TolLo

• PSet_DribbleQty

• PSet_Preact

• PSet_SP

• PSet_TolHi

• PSet_TolLo

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

Publication SYSLIB-RM020C-EN-E - October 2011 19

Page 32: P DoseFM 2.0 Syslib-rm020

Chapter 2 Configuration Options

Cfg_SimDribbleRate 0.1 EU / rate time Engineering This parameter determines the flow rate presented (Val_Rate) when running Dribble Flow (Out_DribbleFlow) in simulation. This rate is integrated (totalized) to generate the delivery quantity (Val_Qty).

IMPORTANT Simulation provides a rate and totalizes it to a delivery quantity regardless of the configuration of Cfg_CalcQty and Cfg_CalcRate.

• Cfg_RateTime

• Inp_Sim

• Out_DribbleFlow

• Val_Qty

• Val_Rate

Cfg_SimRate 1.0 EU / rate time Engineering This parameter determines the flow rate presented (Val_Rate) when running full flow (Out_RunFlow) in simulation. This rate is integrated (totalized) to generate the delivery quantity (Val_Qty).

IMPORTANT Simulation provides a rate and totalizes it to a delivery quantity regardless of the configuration of Cfg_CalcQty and Cfg_CalcRate.

• Cfg_RateTime

• Inp_Sim

• Out_RunFlow

• Val_Qty

• Val_Rate

Cfg_ClearPulseT 1 Maintenance Enter the time (in seconds) to pulse the Out_ClearTot output in order to clear the quantity in a flowmeter which has its own totalizer.

• Inp_RunFdbk

• Inp_DribbleFdbk

• Inp_StopFdbk

• Sts_EqpFault

• Alm_EqpFault

• Cfg_HasEqpFdbk

• Cfg_UseEqpFdbk

Cfg_FaultT 10 Maintenance Enter the time (in seconds) to give the equipment feedback to reach the commended state (stopped, flowing, or dribbling) before raising the Equipment Fault Status.

• Inp_RunFdbk

• Inp_DribbleFdbk

• Inp_StopFdbk

• Sts_EqpFault

• Alm_EqpFault

• Cfg_HasEqpFdbk

• Cfg_UseEqpFdbk

Parameter: Default:Faceplate Tab Location: Usage: Associated Parameters:

20 Publication SYSLIB-RM020C-EN-E - October 2011

Page 33: P DoseFM 2.0 Syslib-rm020

Chapter 3

Instruction Data Reference

This chapter describes the P_DoseFM Instruction’s public parameters.

The descriptions in the table below show how these data elements are used with the P_DoseFM Add-On Instruction.

Execution Execution parameters are included with every Add-On Instruction. See the Logix5000 Controllers Add-On Instructions Programming Manual, publication 1756-PM010, for more information on these data elements.

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

EnableIn BOOL Input 1 Enable Input:1 = Normal Scan: control / monitor Dosing

with Flowmeter 0 = Clear any ’lurking’ Commands and all

Readies, set NO MODE

EnableOut BOOL Output 0 Enable Output: The EnableOut signal is not manipulated by this instruction. Its output state always reflects the EnableIn input state.

Inf_Tab SINT Output 0 Decimal Tab to display (FTView ME)

Inf_Type STRING_16 Output ’P_DoseFM’ Must contain AOI name, used for HMI and Information S/W

P_DoseFM BOOL Output 0 Unique Parameter Name for auto - discovery

21Publication SYSLIB-RM020C-EN-E - October 2011 21

Page 34: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Inputs (Inp_)

Input data elements are used to connect field inputs from I/O modules or signals from other objects to the P_DoseFM instruction. Each Input used should have mapping logic or a function block wire to get the input value from the input card or other instruction every scan.

Name: Data Type: Usage: Default: Style: Description:Associated Configuration Parameter

Inp_RatePV REAL Input 0.0 Float Flow Rate from Flowmeter (EU/time, see Cfg_RateTime)

• Cfg_CalcQty

• Cfg_CalcRate

• Cfg_EUQtyMult

• Cfg_LoRateCutoff

• Cfg_RateTime

Inp_QtyPV REAL Input 0.0 Float Quantity from Flowmeter (EU or Pulse Count)

• Cfg_CalcQty

• Cfg_CalcRate

• Cfg_ClearPulseT

• Cfg_CountsPerEU

• Cfg_RateFiltTC

• Cfg_RateTime

• Cfg_Rollover

Inp_RunFdbk BOOL Input 0 Level 1 = Controlled Equipment is Delivering (Running)

Inp_DribbleFdbk BOOL Input 0 Level 1 = Controlled Equipment is Delivering at Dribble

Inp_StopFdbk BOOL Input 0 Level 1 = Controlled Equipment is confirmed Stopped

Inp_RatePVBad BOOL Input 0 Level 1 = Rate PV Input Quality = Bad (fail)

Inp_RatePVUncertain BOOL Input 0 Level 1 = Rate PV Input Quality = Uncertain

Inp_QtyPVBad BOOL Input 0 Level 1 = Quantity PV Input Quality = Bad (fail)

Inp_QtyPVUncertain BOOL Input 0 Level 1 = Quantity PV Input Quality = Uncertain

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 flowmeter0 = use actual flowmeter

• Cfg_SimDribbleRate

• Cfg_SimRate

Inp_Reset BOOL Input 0 Level 1 = Reset all fault conditions and latched Alarms

• Cfg_EqpFaultResetReqd

• Cfg_OverTolResetReqd

• Cfg_UnderTolResetReqd

• Cfg_ZeroFaultResetReqd

22 Publication SYSLIB-RM020C-EN-E - October 2011

Page 35: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

Outputs (Out_)

Output data elements are used to connect from the P_DoseFM Instruction to field outputs on I/O modules or to other objects. Each Output used should have mapping logic or a function block wire to write the output value to the output card or other object every scan.

Configurations (Cfg_)

Configuration data elements are used to set configurable capabilities, features and functions of the P_DoseFM Instruction. The following Configuration data may be modified by controller application logic, using the HMI Faceplate,

or using the Tag Monitor in RSLogix 5000 software.

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

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

Out_RunTot BOOL Output 0 1 = Run external totalizer (e.g. onboard flowmeter)

Out_ClearTot BOOL Output 0 1 = Reset external totalizer (e.g. onboard flowmeter)

• Cfg_ClearPulseT

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Cfg_HasDribble BOOL Input 0 Level 1 = Slow to Dribble before complete

0 = Use Run full flow until complete

Cfg_HasEqpFdbk BOOL Input 0 Level 1 = Controlled Equipment provides Run (Dribble if used) and Stop Feedback

• Inp_RunFdbk

• Inp_DribbleFdbk

• Inp_StopFdbk

• Sts_EqpFault

• Alm_EqpFault

• Cfg_FaultT

Cfg_UseEqpFdbk BOOL Input 0 Level 1 = Use run / dribble / stop feedback, 0=Assume equipment state

• Inp_RunFdbk

• Inp_DribbleFdbk

• Inp_StopFdbk

• Sts_EqpFault

• Alm_EqpFault

• Cfg_FaultT

Publication SYSLIB-RM020C-EN-E - October 2011 23

Page 36: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Cfg_AutoAdjPreact BOOL Input 0 Level 1 = Enable automatic adjustment of preact after each delivery

• Cfg_AutoAdjPct

Cfg_CalcRate BOOL Input 0 Level 1 = Differentiate Inp_Qty to get Rate

0 = Use Inp_Rate

• Cfg_RateFiltTC

• Cfg_RateTime

Cfg_CalcQty BOOL Input 0 Level 1 = Integrate Inp_Rate to get Quantity

0 = Use Inp_Qty

• Cfg_EUQtyMult

• Cfg_RateTime

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 Commands on receipt

0 = Leave Set

Cfg_ProgDefault BOOL Input 0 Level Default Mode: 1=Program Mode if no request 0=Operator Mode if no requests

Cfg_ShedOnEqpFault BOOL Input 0 Level 1=Stop delivery and Alarm on Equipment Fault

0=Alarm only on Equipment Fault

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_HasOverTolAlm BOOL Input 0 Level 1 = Over Tolerance Alarm exists and will be checked

Cfg_HasUnderTolAlm BOOL Input 0 Level 1 = Under Tolerance Alarm exists and will be checked

Cfg_HasZeroFaultAlm BOOL Input 0 Level 1 = Zero Fault Alarm exists and will be checked

Cfg_HasEqpFaultAlm BOOL Input 0 Level 1 = Equipment Fault Alarm exists and will be checked

Cfg_OverTolResetReqd BOOL Input 0 Level 1 = Reset required to clear Over Tolerance Alarm

Cfg_UnderTolResetReqd BOOL Input 0 Level 1 = Reset required to clear Under Tolerance Alarm

Cfg_ZeroFaultResetReqd BOOL Input 0 Level 1 = Reset required to clear Zero Fault Alarm

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

24 Publication SYSLIB-RM020C-EN-E - October 2011

Page 37: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

Cfg_EqpFaultResetReqd BOOL Input 0 Level 1 = Reset required to clear Equipment Fault Alarm

Cfg_OverTolAckReqd BOOL Input 1 Level 1 = Acknowledge required for Over Tolerance Alarm

Cfg_UnderTolAckReqd BOOL Input 1 Level 1 = Acknowledge required for Under Tolerance Alarm

Cfg_ZeroFaultAckReqd BOOL Input 1 Level 1 = Acknowledge required for Zero Fault Alarm

Cfg_EqpFaultAckReqd BOOL Input 1 Level 1 = Acknowledge required for Equipment 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 = Warning3 = Exception4 = Fault

Cfg_ZeroFaultSeverity SINT Input 4 Decimal Zero Fault Alarm Severity

1 = Information2 = Warning3 = Exception4 = Fault

Cfg_EqpFaultSeverity SINT Input 4 Decimal Equipment Fault Alarm Severity

1 = Information2 = Warning3 = Exception4 = Fault

Cfg_MaxQty REAL Input 1.00E+38 Float Maximum allowed quantity to deliver (setpoint) (EU)

Cfg_EUQtyMult REAL Input 1.0 Float Rate to Quantity EU Multiplier (e.g., Gal to Bbl.)

• Cfg_CountsPerEU

Cfg_Rollover REAL Input 0.0 Float Quantity Rollover (e.g., max. count for pulse input)

• Cfg_CountsPerEU

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Publication SYSLIB-RM020C-EN-E - October 2011 25

Page 38: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Because they contain arrayed or structured data types, the following Configuration data elements use P_DoseFM Add-On Instruction Local Tags.

Cfg_CountsPerEU REAL Input 1.0 Float Number of Counts in Inp_QtyPV which equal 1.0 EU

• Cfg_Rollover

Cfg_RateTime REAL Input 1.0 Float Time factor for rate (60.0 for EU/minute, 3600.0 for EU/hour) (in seconds)

• Cfg_EUQtyMult

• Cfg_SimDribbleRate

• Cfg_SimRate

Cfg_RateFiltTC REAL Input 0.1 Float Filter Time Constant (sec) for calculated Rate

• Cfg_LoRateCutoff

Cfg_LoRateCutoff REAL Input 0.0 Float Rate below which to report zero flow (Inp_RatePV units)

• Cfg_LoRateCutoff

Cfg_BumpT REAL Input 0.0 Float Bump (manual top-off) Time (Sec)

Cfg_AutoAdjPct REAL Input 10.0 Float Percentage of delivery error to auto-adjust preact (%)

• Cfg_AutoAdjPreact

Cfg_SimRate REAL Input 1.0 Float Rate at which to deliver when running in Simulation (EU/rate time)

Cfg_SimDribbleRate REAL Input 0.1 Float Rate at which to dribble when running in Simulation (EU/rate time)

Cfg_ClearPulseT DINT Input 1 Decimal Time to pulse Out_Clear to clear external totalizer (sec)

Cfg_FaultT DINT Input 10 Decimal Time for Equipment Feedback to follow Output before Fault (sec)

Cfg_OperKeep SINT Input 2#0000_0000 Binary Oper keeps control in Prog Mode: .0=Start/Stop, .1=SP, .2=Dribble/Preact, .3=Tolerances

Cfg_ProgKeep SINT Input 2#0000_0000 Binary Prog keeps control in Oper Mode: .0=Start/Stop, .1=SP, .2=Dribble/Preact, .3=Tolerances

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

26 Publication SYSLIB-RM020C-EN-E - October 2011

Page 39: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

These may be modified using RSLogix 5000 or using the HMI Faceplates, but

cannot be modified using controller logic:

Program Settings (PSet_)

Program Setting data elements are used by application logic to establish setpoints, thresholds, and other settings of the P_DoseFM Instruction. Automation logic may write to these settings any time; the P_DoseFM Instruction uses them in its logic when it is in the Program Mode.

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Cfg_Desc STRING_40 'Dosing with Flowmeter’

String Description for display on HMI

Cfg_Label STRING_20 'Flowmeter Dosing'

String Label for Graphic Object displayed on HMI

Cfg_QtyEU STRING_8 'kg' String Engineering Units for Quantity for display on HMI

Cfg_RateEU STRING_8 'kg/sec' String Engineering Units for Rate (flow) for display on HMI

Cfg_Tag STRING_20 'P_DoseFM' String Tagname for display on HMI

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

PSet_SP REAL Input 0.0 Float Program Setting of total quantity to deliver (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 total to 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)

Publication SYSLIB-RM020C-EN-E - October 2011 27

Page 40: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Program Commands (PCmd_)

Program Command data elements are used by application logic to request P_DoseFM Instruction actions, such as changing Modes, acknowledging alarms, or specific P_DoseFM actions. Application logic sets the Program Command to 1 or 0 to request the action. (See the Edge and Level section in the Preface for more information). The P_DoseFM Instruction then performs the requested action if it is in Program Mode and the action can be performed.

Device Commands

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:

Associated Configuration Parameter

PCmd_ClearTot BOOL Input 0 * Program Command to Clear Totalizer Qty

PCmd_StartTot BOOL Input 0 * Program Command to Start Totalizer

PCmd_StopTot BOOL Input 0 ** Program Command to Stop Totalizer

PCmd_StartFlow BOOL Input 0 * Program Command to Start Delivery

PCmd_StopFlow BOOL Input 0 ** Program Command to Stop/Pause Delivery

PCmd_CheckTol BOOL Input 0 * Program Command to Check Tolerances • Cfg_AutoAdjPreact

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

PCmd_Acq BOOL Input 0 * Program Command to Acquire ownership (Oper to Prog)

PCmd_Rel BOOL Input 0 ** Program Command to Release ownership (Prog to Oper)

PCmd_Lock BOOL Input 0 * Program Command to Lock Mode in Prog

PCmd_Unlock BOOL Input 0 ** Program Command to Unlock Mode

28 Publication SYSLIB-RM020C-EN-E - October 2011

Page 41: P DoseFM 2.0 Syslib-rm020

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:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

PCmd_Reset BOOL Input 0 * Program Command to Reset all Alarms requiring Reset

• Cfg_OverTolResetReqd

• Cfg_UnderTolResetReqd

• Cfg_ZeroFaultAckReqd

• Cfg_EqpFaultResetReqd

PCmd_OverTolAck BOOL Input 0 * Program Command to Acknowledge Out of Tolerance High Alarm

• Cfg_OverTolAckReqd

PCmd_OverTolInhibit BOOL Input 0 * Program Command to Inhibit Out of Tolerance High Alarm

PCmd_OverTolUninhibit BOOL Input 0 ** Program Command to Uninhibit Out of Tolerance High Alarm

PCmd_UnderTolAck BOOL Input 0 * Program Command to Acknowledge Out of Tolerance Low Alarm

• Cfg_UnderTolAckReqd

PCmd_UnderTolInhibit BOOL Input 0 * Program Command to Inhibit Out of Tolerance Low Alarm

PCmd_UnderTolUninhibit BOOL Input 0 ** Program Command to Uninhibit Out of Tolerance Low Alarm

PCmd_ZeroFaultAck BOOL Input 0 * Program Command to Acknowledge Zero Fault Alarm

• Cfg_ZeroFaultAckReqd

PCmd_ZeroFaultInhibit BOOL Input 0 * Program Command to Inhibit Zero Fault Alarm

PCmd_ZeroFaultUninhibit BOOL Input 0 ** Program Command to Uninhibit Zero Fault Alarm

PCmd_EqpFaultAck BOOL Input 0 * Program Command to Acknowledge Equipment Fault Alarm

• Cfg_EqpFaultAckReqd

PCmd_EqpFaultInhibit BOOL Input 0 * Program Command to Inhibit Equipment Fault Alarm

PCmd_EqpFaultUninhibit BOOL Input 0 ** Program Command to Uninhibit Equipment Fault Alarm

Publication SYSLIB-RM020C-EN-E - October 2011 29

Page 42: P DoseFM 2.0 Syslib-rm020

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 HMI Faceplate to let the operator establish setpoints, thresholds, and other settings of the P_DoseFM Instruction. The P_DoseFM Instruction uses Other Settings in its logic regardless of Mode. It uses Operator and Maintenance Settings 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 used for certain Operator or Maintenance Settings. Rdy_OSet applies to all Operator or Maintenance Settings for which there are no specific Ready bits.

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

OSet_SP REAL Input 0.0 Float Operator Setting of total quantity to deliver (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 total to stop flow (EU)

• Cfg_AutoAdjPct

• Cfg_AutoAdjPreact

• Cfg_SetTrack

OSet_TolHi REAL Input 0.0 Float Operator Setting of High Tolerance Limit (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:

Associated Configuration Parameter

Rdy_OSet BOOL Output 0 1 = Ready to receive OSets (enables data entry fields)

Rdy_SP BOOL Output 0 1=Ready to receive OSet_SP

Rdy_DribPre BOOL Output 0 1=Ready to receive OSet_DribbleQty or OSet_Preact

Rdy_Tol BOOL Output 0 1=Ready to receive OSet_TolHi or Oset_TolLo

30 Publication SYSLIB-RM020C-EN-E - October 2011

Page 43: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

Operator Commands, Maintenance Commands, Command Readies (OCmd_, MCmd_, Rdy_)

Operator Commands and Maintenance Commands are used by the operator at the HMI to request instruction actions, such as changing modes; acknowledging, enabling or disabling, suppressing or unsuppressing alarms; or other instruction-specific actions. These Commands are set (latched) by the HMI and are read and then cleared (unlatched) and acted upon by the P_DoseFM instruction, allowing a many-to-one relationship between HMI requestors and each Command. Commands are implemented as public Input Parameters of the instruction or as Input Parameters of instructions internal to the P_DoseFM instruction (embedded Commands").

Device Commands

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

OCmd_ClearTot BOOL Input 0 Edge Operator Command to Clear Totalizer Qty

OCmd_StartTot BOOL Input 0 Edge Operator Command to Start Totalizer

OCmd_StopTot BOOL Input 0 Edge Operator Command to Stop Totalizer

OCmd_StartFlow BOOL Input 0 Edge Operator command to Start Deliver

OCmd_StopFlow BOOL Input 0 Edge Operator Command to Stop/Pause Delivery

OCmd_CheckTol BOOL Input 0 Edge Operator Command to Check Tolerances

• Cfg_AutoAdjPreact

OCmd_Bump BOOL Input 0 Edge if Cfg_BumpT>0

Level if Cfg_BumpT=0

Operator Command to Bump Delivery for Under Tolerance

• Cfg_AutoAdjPreact

• Cfg_BumpT

Publication SYSLIB-RM020C-EN-E - October 2011 31

Page 44: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Mode Commands

Alarm Commands

IMPORTANT Mode Commands are sent to a P_Mode Instruction embedded within the P_DoseFM Instruction. The P_Mode Instruction instance is named "Mode".

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Mode.MCmd_Acq BOOL Input 0 Edge Maintenance Command to Acquire Ownership (Oper/Prog/Ovrd to Maint)

Mode.MCmd_Rel BOOL Input 0 Edge Maintenance Command to Release Ownership (Maint to Oper/Prog/Ovrd)

Mode.OCmd_AcqLock BOOL Input 0 Edge Operator Command to Acquire and Lock Mode in Oper

Mode.OCmd_Unlock BOOL Input 0 Edge Operator command to Unlock Operator Mode

IMPORTANT Alarm Commands are sent to P_Alarm Instructions embedded within the P_DoseFM Instruction. Each P_Alarm Instruction instance is named for the alarm condition.

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

OCmd_Reset BOOL Input 0 Edge Operator Command to Reset all Alarms requiring Reset

OCmd_ResetAckAll BOOL Input 0 Edge Operator Command to Reset all Alarms and latched Shed conditions

OverTol.OCmd_Reset BOOL Input 0 Edge Operator Command to Reset latched Over Tolerance Alarm

• Cfg_OverTolResetReqd

OverTol.OCmd_Ack BOOL Input 0 Edge Operator Command to Acknowledge Over Tolerance Alarm

• Cfg_OverTolAckReqd

OverTol.OCmd_Disable BOOL Input 0 Edge Operator Command to Disable Over Tolerance Alarm

OverTol.OCmd_Enable BOOL Input 0 Edge Operator Command to Enable Over Tolerance Alarm

UnderTol.OCmd_Reset BOOL Input 0 Edge Operator Command to Reset latched Under Tolerance Alarm

• Cfg_UnderTolResetReqd

32 Publication SYSLIB-RM020C-EN-E - October 2011

Page 45: P DoseFM 2.0 Syslib-rm020

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 when received. The Ready bit is used to enable (1) or gray-out (0) the Command button on the Faceplate.

UnderTol.OCmd_Ack BOOL Input 0 Edge Operator Command to Acknowledge Under Tolerance Alarm

• Cfg_UnderTolAckReqd

UnderTol.OCmd_Disable BOOL Input 0 Edge Operator Command to Disable Under Tolerance Alarm

UnderTol.OCmd_Enable BOOL Input 0 Edge Operator Command to Enable Under Tolerance Alarm

ZeroFault.OCmd_Reset BOOL Input 0 Edge Operator Command to Reset latched Zero Fault Alarm

• Cfg_ZeroFaultResetReqd

ZeroFault.OCmd_Ack BOOL Input 0 Edge Operator Command to Acknowledge Zero Fault Alarm

• Cfg_ZeroFaultAckReqd

ZeroFault.OCmd_Disable BOOL Input 0 Edge Operator Command to Disable Zero Fault Alarm

ZeroFault.OCmd_Enable BOOL Input 0 Edge Operator Command to Enable Zero Fault Alarm

EqpFault.OCmd_Reset BOOL Input 0 Edge Operator Command to Reset latched Equipment Fault Alarm

• Cfg_EqpFaultResetReqd

EqpFault.OCmd_Ack BOOL Input 0 Edge Operator Command to Acknowledge Equipment Fault Alarm

• Cfg_EqpFaultAckReqd

EqpFault.OCmd_Disable BOOL Input 0 Edge Operator Command to Disable Equipment Fault Alarm

EqpFault.OCmd_Enable BOOL Input 0 Edge Operator Command to Enable Equipment Fault Alarm

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Rdy_ClearTot BOOL Output 0 1 = Ready for OCmd_ClearTot (enables HMI button)

Rdy_StartTot BOOL Output 0 1 = Ready for OCmd_StartTot (enables HMI button)

Rdy_StopTot BOOL Output 0 1 = Ready for OCmd_StopTot (enables HMI button)

Rdy_StartFlow BOOL Output 0 1 = Ready for OCmd_StartFlow (enables HMI button)

Publication SYSLIB-RM020C-EN-E - October 2011 33

Page 46: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Mode Command Readies

Rdy_StopFlow BOOL Output 0 1 = Ready for OCmd_StopFlow (enables HMI button)

Rdy_CheckTol BOOL Output 0 1 = Ready for OCmd_CheckTol (enables HMI button)

Rdy_Bump BOOL Output 0 1 = Ready for OCmd_Bump (enables HMI button)

P_DoseFM BOOL Output 0 Unique Parameter Name for auto-discovery

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

IMPORTANT Mode Command Readies are provided by a P_Mode Instruction embedded within the P_DoseFM Instruction. The P_Mode Instruction instance is named "Mode".

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Mode.Rdy_Acq BOOL Output 0 1 = Ready for MCmd_Acq (enables HMI button)

Mode.Rdy_Rel BOOL Output 0 1 = Ready for MCmd_Rel (enables HMI button)

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 HMI button)

34 Publication SYSLIB-RM020C-EN-E - October 2011

Page 47: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

Alarm Command Readies

IMPORTANT Alarm Command Readies are provided by P_Alarm Instructions embedded within the P_DoseFM Instruction. Each P_Alarm Instruction instance is named for the alarm condition.

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Rdy_Reset BOOL Output 0 1 = Ready for OCmd_Reset (enables HMI button)

Rdy_ResetAckAll BOOL Output 0 1 = Ready for OCmd_ResetAckAll (enables HMI button)

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)

ZeroFault.Rdy_Reset BOOL Output 0 1 = Ready for ZeroFault.OCmd_Reset (enables HMI button)

ZeroFault.Rdy_Ack BOOL Output 0 1 = Ready for ZeroFault.OCmd_Ack (enables HMI button)

ZeroFault.Rdy_Disable BOOL Output 0 1 = Ready for ZeroFault.OCmd_Disable (enables HMI button)

ZeroFault.Rdy_Enable BOOL Output 0 1 = Ready for ZeroFault.OCmd_Enable (enables HMI button)

EqpFault.Rdy_Reset BOOL Output 0 1 = Ready for EqpFault.OCmd_Reset (enables HMI button)

Publication SYSLIB-RM020C-EN-E - October 2011 35

Page 48: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

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)

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

36 Publication SYSLIB-RM020C-EN-E - October 2011

Page 49: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

Values (Val_)

Value data elements contain process or device variables, the notification level for alarm animation, and the current accepted values of any thresholds or other settings (from Program or Operator Settings) for the P_DoseFM instruction. The HMI displays these Values, and they are available for use by other application logic.

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Val_Qty REAL Output 0.0 Float Quantity actually delivered (totalizer output) (EU)

• Cfg_CalcQty

• Cfg_CountsPerEU

• Cfg_EUQtyMult

• Cfg_HasDribble

• Cfg_LoRateCutoff

• Cfg_RateTime

• Cfg_Rollover

• Cfg_SimDribbleRate

• Cfg_SimRate

Val_Rate REAL Output 0.0 Float Current Delivery Rate (EU/time) (see Cfg_RateTime)

• Cfg_CalcRate

• Cfg_RateFiltTC

• Cfg_RateTime

• Cfg_SimDribbleRate

• Cfg_SimRate

Val_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 reach Setpoint (EU)

Val_PctComplete REAL Output 0.0 Float Percent Complete (for Progress Bar on 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 will be 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)

Publication SYSLIB-RM020C-EN-E - October 2011 37

Page 50: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Val_Cmd SINT Output 0 Decimal This shows the command being processed, returns to zero once the command succeeds or fails. May be made not visible if zero. These values are also used for Inp_OvrCmd. 0 = None 1 = Clear Totalizer 2 = Start Totalizer 3 = Start Delivery 4 = Start Dribble 5 = Bump 6 = Stop Delivery 7 = Stop Totalizer

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 to show the operator the "confirmed" device status. 0 = Power Up / Reset 1 = Stopped 2 = Totalizing 3 = Delivering 4 = Dribbling 5 = Bumping 6 = Start Delivery 7 = Start Dribble 8 = Stopping 33 = Disabled

Val_Fault SINT Output 0 Decimal This is the DEVICE FAULT STATUS, used to show the operator the most sever device fault. 0 = None 17 = Equipment Fault 34 = Configuration Error

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

38 Publication SYSLIB-RM020C-EN-E - October 2011

Page 51: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

Val_Mode SINT Output 0 Decimal This exists if P_Mode is used within the object and shows all modes used by (implemented in) the object. 0 = No Mode 2 = Maintenance 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 = not owned)

Val_Notify SINT Output 0 Decimal Current Alarm Level and Acknowledgement (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_UnderTolSeverity

• Cfg_ZeroFaultSeverity

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Publication SYSLIB-RM020C-EN-E - October 2011 39

Page 52: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Status (Sts_)

Status data elements contain process or device states, Mode status and Alarm status. The HMI displays these Status points, and they are available for use by other application logic.

Device Status

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Sts_Cleared BOOL Output 0 1 = Totalizer Clear completed

Sts_TotRunning BOOL Output 0 1 = Totalizer Running0 = Totalizer Stopped

Sts_FlowStarting BOOL Output 0 1=Flow is Starting (Out_Run is ON, Fdbk not 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_Dribble is ON)

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_LoRateCutoff BOOL Output 0 1 = Rate PV below low rate cutoff, flow assumed to be zero

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 by automation (Prog)

Sts_QtyBad BOOL Output 0 1 = Quantity Value is Bad (PV Fail)

Sts_QtyUncertain BOOL Output 0 1 = Quantity Value is Uncertain

Sts_RateBad BOOL Output 0 1 = Rate Value is Bad (PV Fail)

Sts_RateUncertain BOOL Output 0 1 = Rate Value is Uncertain

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 Err bits for reason

40 Publication SYSLIB-RM020C-EN-E - October 2011

Page 53: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

Mode Status

Err_EU BOOL Output 0 1 = Error: Cfg_CountsPerEU, Cfg_EUQtyMult or Cfg_Rollover invalid

Err_Rate BOOL Output 0 1 = Error: Cfg_RateFiltTC or Cfg_RateTime invalid

Err_Cutoff BOOL Output 0 1 = Error: Cfg_LoRateCutoff invalid

Err_Limit BOOL Output 0 1 = Error: Cfg_MaxQty invalid

Err_Sim BOOL Output 0 1 = Error: Cfg_SimDribbleRate or Cfg_SimRate invalid

Err_Timer BOOL Output 0 1 = Error: Cfg_BumpT or Cfg_ClearPulseT (use 0.0 to 2147483.647)

Err_Alarm BOOL Output 0 1 = Error: Alarm Min Duration or Severity Cfg Invalid

Err_Keep BOOL Output 0 1 = Error in Config: Invalid setup of Cfg_OperKeep and Cfg_ProgKeep

Name: Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Sts_Maint BOOL Output 0 1 = Mode is Maintenance (supersedes Ovrd, 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 requested Mode Lock

Sts_NoMOde BOOL Output 0 1 = NoMode (Disabled because EnableIn is False)

Publication SYSLIB-RM020C-EN-E - October 2011 41

Page 54: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Alarm Status

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Sts_OverTol BOOL Output 0 1 = Delivery Out of Tolerance High

Alm_OverTol BOOL Output 0 1 = Delivery Out of Tolerance High Alarm

• Cfg_OverTolResetReqd

Ack_OverTol BOOL Output 0 1 = OverTolerance Alarm Acknowledged

• Cfg_OverTolAckReqd

Sts_OverTolDisabled BOOL Output 0 1 = OverTolerance Alarm Disabled (will not be sent)

Sts_OverTolInhibited BOOL Output 0 1 = OverTolerance Alarm Inhibited by logic

Sts_OverTolSuppressed BOOL Output 0 1 = OverTolerance Alarm Suppressed (logged only)

Sts_UnderTol BOOL Output 0 1 = Delivery Out of Tolerance Low

Alm_UnderTol BOOL Output 0 1 = Delivery Out of Tolerance Low Alarm

• Cfg_UnderTolResetReqd

Ack_UnderTol BOOL Output 0 1 = Under Tolerance Alarm Acknowledged

• Cfg_UnderTolAckReqd

Sts_UnderTolDisabled BOOL Output 0 1 = Under Tolerance Alarm Disabled (will not be sent)

Sts_UnderTolInhibited BOOL Output 0 1 = Under Tolerance Alarm Inhibited by logic

Sts_UnderTolSuppressed BOOL Output 0 1 = Under Tolerance Alarm Suppressed (logged only)

Sts_ZeroFault BOOL Output 0 Decimal 1 = Total did not clear or unexpected flow

Alm_ZeroFault BOOL Output 0 1 = Warning: Total did not clear or still flowing

• Cfg_ZeroFaultResetReqd

Ack_ZeroFault BOOL Output 0 1 = Zero Fault Alarm Acknowledged

• Cfg_ZeroFaultAckReqd

Sts_ZeroFaultDisabled BOOL Output 0 1 = Zero Fault Alarm Disabled (not saved or sent)

Sts_ZeroFaultInhibited BOOL Output 0 1 = Zero Fault Alarm Inhibited by logic

Sts_ZeroFaultSuppressed BOOL Output 0 1 = Zero Fault Alarm Suppressed (logged only)

42 Publication SYSLIB-RM020C-EN-E - October 2011

Page 55: P DoseFM 2.0 Syslib-rm020

Instruction Data Reference Chapter 3

Sts_EqpFault BOOL Output 0 Decimal 1 = Equipment Fault Detected

Alm_EqpFault BOOL Output 0 1 = Alarm: Equipment Fault (sensor or controlled equipment)

• Cfg_EqpFaultResetReqd

Ack_EqpFault BOOL Output 0 1 = Equipment Fault Alarm Acknowledged

• Cfg_EqpFaultAckReqd

Sts_EqpFaultDisabled BOOL Output 0 1 = Equipment Fault Alarm Disabled (will not be sent)

Sts_EqpFaultInhibited BOOL Output 0 1 = Equipment Fault Alarm Inhibited by logic

Sts_EqpFaultSuppressed BOOL Output 0 1 = Equipment Fault Alarm Suppressed (logged only)

Name:Data Type: Usage: Default: Style: Description:

Associated Configuration Parameter

Publication SYSLIB-RM020C-EN-E - October 2011 43

Page 56: P DoseFM 2.0 Syslib-rm020

Chapter 3 Instruction Data Reference

Notes:

44 Publication SYSLIB-RM020C-EN-E - October 2011

Page 57: P DoseFM 2.0 Syslib-rm020

Chapter 4

HMI Reference

This chapter describes the HMI Graphic Objects and Faceplates provided for the Operator interface for the P_DoseFM Instruction.

Graphic Objects Graphic objects are provided for use on end-user process graphic displays. Flowmeter Dosing graphic objects have the following common attributes:

Each Flowmeter Dosing Graphic Symbol displays the object’s label and engineering units text, the current value of the flow rate and quantity delivered in this dosing, and various status indicators. The current values of the quantity and rate change color depending on the input signal quality. The graphic symbol has a color changing alarm border that blinks on unacknowledged alarm.

The overall Graphic Symbol includes a touch field over it which calls up the object’s Faceplate. In addition, pausing the pointing device over the Graphic Symbol displays a tooltip showing the object’s configured Tag and Description.

Progress Bar (Percent Complete)Status / Quality

Indicator

Quantity Value

Label

Rate Value

Alarm Indicator

Quantity and Rate Engineering Units

Totalizer State Text

Flowmeter Symbol

Mode Indicator

Alarm Border

45Publication SYSLIB-RM020C-EN-E - October 2011 45

Page 58: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Graphic Representation

The Rate Value and Quantity Value displays change color based on the highest

severity alarm currently active.

The color of the Flowmeter symbol changes depending on the commanded

state of the controlled equipment:

The color of the Totalizer (‘FQI’) symbol changes depending on the current

state of totalizing:

Status / Quality Indicators

One of these symbols appears to the left of the Rate Value when the described condition is true

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

Color Totalizer State

Gray Stopped

Dark Green Running

Graphic Symbol Description

Invalid Configuration

Rate or Total Input Quality Bad (‘stale’)

Rate or Total Input Quality Uncertain

The device is not ready to operate

No symbol displayed Rate and Total Input Quality Good and no Invalid Configuration entries

46 Publication SYSLIB-RM020C-EN-E - October 2011

Page 59: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

TIPWhen the Invalid Configuration Indicator appears, you can find what configuration setting is invalid by following the indicators like a ‘trail of breadcrumbs’. Click the Graphic Symbol to call up the Faceplate. The Invalid Configuration indicator will appear next to the appropriate tab at the top of the Faceplate to guide you in finding the configuration error. Once you navigate to the tab, the misconfigured item will be flagged with this indicator or appear in a magenta box.

For the Flowmeter Dosing Instruction, the Invalid Configuration Indicator appears under any of the following conditions:

• The number of input counts per unit of flow (Cfg_CountsPerEU) is set to a negative value.

• The quantity engineering units multiplier (Cfg_EUQtyMult) is set to a negative value.

• The pulse input rollover count is set to a negative value.

• The low rate cutoff value (Cfg_LoRateCutoff) is set to a negative value.

• The maximum allowed quantity setpoint (Cfg_MaxQty) is set to a negative value or zero.

• The first-order filter time constant is set to a negative value.

• The Bump Time (Cfg_BumpT) or external totalizer Clear Pulse Time (Cfg_ClearPulseT) is set to a value less than zero or greater than 2,147,483 seconds.

• The time used for flow rate (differentiating) or flow quantity (integrating) calculations (Cfg_RateTime) is set to a negative value or zero. Use 1.0 for EU/sec, 60.0 for EU/min, 3600.0 for EU/hr, or a similar value

• The normal flow rate or dribble flow rate used in simulation (Cfg_SimRate, Cfg_SimDribbleRate) is set to a negative value or zero.

• An Alarm Deadband is set to a negative value.

• An Alarm Minimum Duration is set to a value less than zero or greater than 2,147,483 seconds.

• An Alarm Severity is set to a value other than 1 (information), 2 (warning), 3 (exception) or 4 (fault).

Publication SYSLIB-RM020C-EN-E - October 2011 47

Page 60: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Mode Indicators

One of these symbols appears to the right of the Process Variable to indicate the Mode of the Flowmeter Dosing instruction:

TIPThe Mode indicator may not appear if the instruction is in its default mode.

Alarm Indicators

One of these symbols appears to the left of the Label to indicate the described alarm condition. The alarm border and label background blink if

Acknowledgement of an alarm condition is required.

Graphic Symbol Description

No Mode: the instruction is scanned false and is out of service The Process Variable and Alarms are not updated

The instruction is in Maintenance Mode

The instruction is in Program Mode

The instruction is in Operator Mode

Symbol Description

Black ‘I’ in white box with black border

Alarm Inhibit: an alarm is Inhibited by the Program, Disabled by Maintenance or Suppressed by the Operator.

White bell, border, and text background

Return to Normal (no Alarm condition), but a previous Alarm has not been acknowledged

Blue border and text background Yellow rectangle with exclamation point (!)

Information Severity Alarm

Yellow border and text background Orange triangle with exclamation point (!)

Warning Severity Alarm

48 Publication SYSLIB-RM020C-EN-E - October 2011

Page 61: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Using Graphics Symbols

The graphic symbol for P_DoseFM can be found in the global object file (RA-BAS) Process Graphics Library.ggfx. To use the graphic symbol, copy it from the global object file and paste it in the display file. Next, right click on the global object file in the display file and select ‘Global Object Parameter Values’ and the following window appears:

Enter the tag(s) in the "Value" column as specified in the "Description" column.

Note: Values for items marked "(optional)" may be left blank.

Red border and text background Orange diamond with exclamation point (!)

Exception Severity Alarm

Magenta border and text background Red circle with exclamation points (!!)

Fault Severity Alarm

No symbol or border displayed, text is on normal (light gray) background, not blinking

No Alarm or Alarm Inhibit condition, and all Alarms are Acknowledged

Symbol Description

Publication SYSLIB-RM020C-EN-E - October 2011 49

Page 62: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Faceplate The Flowmeter Dosing Faceplate consists of six tabbed pages. The Operator tab is displayed when the Faceplate is initially called up. Click the appropriate icon at the top of the Faceplate to access a specific tab.

The Faceplate provides the means for Operators, Maintenance, Engineers and others to interact with the P_DoseFM Instruction instance, including viewing its Status and Values and manipulating it through its Commands and Settings. When a given input is restricted via FactoryTalk View security, the required user Security Code letter is shown in the tables that follow.

Operator Engineering

Maintenance

Alarms

Alarm Configuration Help

ExitTrends

50 Publication SYSLIB-RM020C-EN-E - October 2011

Page 63: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Operator Tab

The Operator tab shows the following information:

• The current Mode (Program, Operator, Override, Maintenance, or Hand)

• Requested Modes Indicator (Only appears if the Operator or Program Mode has been superseded by another mode. See the Maintenance Tab section for more information.)

• Totalizer Progress Bar if Totalizing or the Totalizer Status ("Cleared", "Complete", or "Complete at Zero")

• Quantity Remaining To Deliver display

• Quantity Delivered display

• Delivery Rate display

Mode Indicator

Operator Mode Unlock and Lock Command Buttons

Check Tolerance Button

Bump Flow Button

I/O Status Indicator

Delivery Progress Bar

Dosing Equipment Commanded State

Start and Stop Flow Buttons

Clear Total Button

Totalizer Low Rate Cutoff Indicator

Reset Acknowledge All Alarms Button

Tolerance Indicator

Publication SYSLIB-RM020C-EN-E - October 2011 51

Page 64: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

• Low Rate Cutoff Indicator (Only appears if the flow Quantity is calculated by totalizing a Rate input and the Rate is less than the Low Rate Cutoff Configuration value Cfg_LoRateCutoff. When this indicator appears, the flow Rate is assumed to be zero for totalizing and the Quantity holds its value.)

• Tolerance Check Result indicator (In Tolerance, Over Tolerance, or Under Tolerance; this appears after performing a Tolerance Check)

• Totalizer State indicator (Stopped or Running)

• The Equipment Commanded State indicator (Stopped, Running, Dribble, or Bumping)

• Quantity Setpoint data entry field

• Dribble Quantity data entry field

• Preact Quantity data entry field

• Communication Status indicator(OK or Fault)

Alarm Status Indicators appear next to values or status indicators that are in alarm. The following table shows the meaning of alarm status indicators on

the Operator tab.

Graphic Object Alarm Status

In Alarm (Active Alarm)

In Alarm and Acknowledged

Out of Alarm but Not Acknowledged

Alarm Suppressed (by Operator) (Alarm is logged but not displayed)

Alarm Disabled (by Maintenance)

Alarm Inhibited (by Program Logic)

52 Publication SYSLIB-RM020C-EN-E - October 2011

Page 65: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

The following table shows the functions on the Operator tab include:

Button/Field Action Security Required

Click to release Operator Mode Lock

Code B

Click to lock in Operator Mode Code B

Click to reset and acknowledge all alarms

Code F

Tolerance Indicator Indicates if the delivery was In Tolerance, Under Tolerance or Over Tolerance. This indicator is only visible when a tolerance check has been requested after delivery is complete.

TIPIf a delivery is Under Tolerance (short) and the Bump function is enabled, the Operator can "bump" the equipment to try to make up the shortfall and bring the delivery into tolerance

Click to clear the totalized quantity Code A

Click to start totalizer Code A

Click to stop totalizer Code A

Click to start or resume delivery Code A

Click to stop (pause) delivery Code A

Publication SYSLIB-RM020C-EN-E - October 2011 53

Page 66: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Click to perform a tolerance check on the delivered quantity

Code A

Click to "bump" flow. This function is used to "top off" a delivery that has passed the preact point but is still short of the Setpoint quantity.

Code A

Setpoint Quantity Configure the amount to deliver Code A

Button/Field Action Security Required

54 Publication SYSLIB-RM020C-EN-E - October 2011

Page 67: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Alarms Tab

The Alarms Tab displays each alarm for this device. If the alarm is active, the panel behind the alarm will change color to match the severity of the alarm.

Alarm Acknowledge Command Button

Reset Acknowledge All Command Button

Color Definition

Magenta Fault

Red Exception

Yellow Warning

Blue Information

Background (Light Gray) No alarm

Publication SYSLIB-RM020C-EN-E - October 2011 55

Page 68: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

The following table lists the functions on the Alarms tab.

The panel behind the alarm blinks if the alarm requires acknowledgement. Click the button with the check mark to acknowledge the alarm.

Alarm Acknowledge button is enabled if the corresponding Alarm requires acknowledgement.

The Reset and Acknowledge All Alarms button is enabled if any Alarm requires reset or acknowledgement.

Button Action Security Required

Click to acknowledge the alarm Code F

Click to reset and acknowledge all alarms

Code F

56 Publication SYSLIB-RM020C-EN-E - October 2011

Page 69: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Maintenance Tab

The Maintenance tab is divided into two pages.

Maintenance Tab Page 1

The Maintenance tab shows the following information:

• The current Mode (Program, Operator, or Maintenance).

• Requested Modes Indicator - This display highlights all of the modes that have been requested. The left-most highlighted mode is the active mode.

• The current High Tolerance Value

• The current Low Tolerance Value

Mode Indicator

Requested Modes Indicator

Maintenance Mode Acquire and Release Command

Publication SYSLIB-RM020C-EN-E - October 2011 57

Page 70: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

The following table lists the functions on Maintenance Tab Page 1..

Button/Field Action Security Required

Click to request Maintenance Mode.

Code C

Click to release Maintenance Mode.

Code C

Dribble Quantity Configure the amount before the end of delivery at which to switch to a reduced flow rate (dribble) for finer control of the final quantity

Code A

Preact Quantity Configure the amount prior to reaching the Setpoint Quantity at which to command the delivery equipment to stop to allow equipment to react. This helps to prevent overshooting the delivery Setpoint.

Code A

High Tolerance (Offset) Enter the High Tolerance Threshold. When a Tolerance Check is initiated, if the delivered quantity exceeds the setpoint quantity by more than this amount, the delivery is Over Tolerance; the Over Tolerance Alarm is raised if enabled.

Code A

Low Tolerance (Offset) Enter the Low Tolerance Threshold. When a Tolerance Check is initiated, if the delivered quantity falls short of the setpoint quantity by more than this amount, the delivery is Under Tolerance; the Under Tolerance Alarm is raised if enabled. For the Low Tolerance condition, the Operator can command a Bump Flow to try to bring the quantity delivered into tolerance.

Code A

58 Publication SYSLIB-RM020C-EN-E - October 2011

Page 71: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Refer to the Operating Modes section in the Overview (Chapter 1) for more information on modes.

Use Equipment (run, dribble, & stop) Feedback

Check this box to have the instruction use Running, Dribbling, and Stopped feedback signals from the controlled equipment to check for equipment failure.

Unchecked this box to have the instruction command control equipment to run, dribble or stop but does not use the equipment feedback inputs to verify operation or generate equipment feedback failure status or alarms.

Code C

Bumpless Program/Operator Transition

Select to enable or disable bumpless Program/Operator transition of Quantity Setpoint, Dribble Quantity, Preact and Tolerance Threshold settings (tracking).

Code C

Button/Field Action Security Required

Publication SYSLIB-RM020C-EN-E - October 2011 59

Page 72: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Maintenance Tab Page 2

The following table lists the functions on Maintenance Tab Page 2.

Button/Field Action Security Required

Rate below which to report zero flow (Inp_RatePV units)

When the flow rate is less than this valve, it is treated as zero. This prevents totalizing the transmitter error when flow is stopped.

Code D

60 Publication SYSLIB-RM020C-EN-E - October 2011

Page 73: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Percentage of delivery error to auto-adjust preact (%)

When the delivery tolerance is checked, if no bump has occurred and if the delivery is in tolerance, the error (difference between delivery setpoint and actual delivery) is multiplied by this percentage and applied to the Preact. This allows the Preact to "self tune" and learn the correct valve of the Preact over time.

Code D

Time (in seconds) to Pulse Clear Output to clear totalizer

Configure the Time (in seconds) to Pulse the Clear Output to clear an external totalizer, such as one in an intelligent flowmeter.

Code D

Duration of flow When bump button is pressed

Configure the amount of time to command the controlled equipment to run flow when the Bump command button is pressed. If this value is set to zero, the Bump button is treated like a Jog: flow starts when the button is pressed and stops when the button is released. If this value is greater than zero, flow is bumped for the configured time.

Code D

Time for Equipment Feedback to follow Output before Fault

If the Equipment Feedback is being used, the instruction allows this much time after commanding the equipment for the equipment feedback to show the equipment in the commanded state before raising an Equipment Fault Status.

Code D

Button/Field Action Security Required

Publication SYSLIB-RM020C-EN-E - October 2011 61

Page 74: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Engineering Tab

The Engineering tab is divided into three pages.

Engineering Tab Page 1

On Engineering Tab Page 1, users can configure the description, label, tag, quantity units, and rate units for the device.

Configure Device Description, Label, and Tag

Page Navigation

Configure Quantity and Rate units of measure text

Mode Configuration Button

62 Publication SYSLIB-RM020C-EN-E - October 2011

Page 75: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

The following table lists the functions on Engineering Tab Page 1.

Button/Field/Checkboxes Action Security Required

Click to navigate the Mode Configuration popup

Code E

Description Type the device description to be used on the Faceplate title bar.

Code E

Label Type the device label to be used on the Graphic Symbol.

Code E

Tag Type the tagname to be used on the Operator Tab of the Faceplate.

Code E

Quantity Units Type the units of measure descriptor for the Quantity delivered.

Code E

Rate Units Type the units of measure descriptor for the Rate of delivery.

Code E

Auto adjust Preact after each delivery

Check this box to automatically adjust the Preact based on the actual vs. setpoint Quantity after each successful delivery.

Uncheck this box to leave the Preact as entered.

Code E

Integrate Inp_Rate to calculate Quantity

Check this box if the flowmeter provides a Rate input but no Quantity input. The Rate will be totalized (integrated) to calculate Quantity.

Code E

Differentiate Inp_Qty to calculate Rate

Check this box if the flowmeter provides a Quantity input but no Rate input. The rate of change in the Quantity will be used as the Rate.

Code E

Slow to Dribble before Complete Check this box to have the equipment commanded to a slower Dribble rate as delivery nears completion to improve the accuracy of Quantity delivered.

Code E

Clear Program Commands on Receipt

Select to clear Program Commands on Receipt. See Edge and Level in the Preface for more information.

Code E

Publication SYSLIB-RM020C-EN-E - October 2011 63

Page 76: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Engineering Tab Page 2

Page Navigation

64 Publication SYSLIB-RM020C-EN-E - October 2011

Page 77: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

The following table lists the functions on Engineering Tab Page 2.

Field/Checkboxes Action Security Required

Controlled Equipment provides Run, Dribble (if used), and Stop Feedback

Check this box to have the controlled equipment provide feedback of its Running, Dribbling, and Stopped status to this instruction. This instruction will check that the equipment is performing the commended function and provide a Status (an optional Alarm) if the equipment fails to respond as commanded within a configurable time.

TIPThe feedback fault time is configured on the Maintenance tab, page 2.

Uncheck this box to have the controlled equipment does not provide feedback of its status. The instruction will assume the equipment is performing the commanded function and no equipment failure-to-respond checking will occur.

Code E

Stop delivery on Equipment Fault Check this box if you want the dosing instruction to attempt to stop the controlled equipment if an equipment fault is reported (Inp_CtrldEqupFault) or detected (via feedbacks).

Uncheck this box if you want the dosing instruction to keep performing its current function, even if an equipment fault occurs.

Code E

Maximum Allowed Quantity to Deliver

Enter the Maximum Allowed Quantity to Deliver. The Quantity Setpoint is clamped to not exceed this value.

Code E

Number of Counts in Inp_QtyPV which equal one engineering unit

Enter the Number of Counts in Inp_QtyPV which equal one engineering unit of Quantity delivered. This value is used with pulse output flowmeters and a pulse input I/O card.

Code E

Publication SYSLIB-RM020C-EN-E - October 2011 65

Page 78: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Rate to Quantity Engineering Units multiplier

Enter the Rate to Quantity Engineering Units multiplier. This value is used if the input is in one unit of measure, such as gallons per minute, and the total is in another which requires conversion above and beyond time units, such as barrels.

Code E

Quantity Rollover Enter the Quantity Rollover. This value is used when a quantity or pulse count input rolls over to zero at some value, such as 999,999 counts.

Code E

Filter Time Constant for calculated rate

Enter the Filter Time Constant for calculated rate

Code E

Time Factor for Rate Enter the Time Factor for Rate. If the rate is in units per second, enter 1.0; if the rate is in units per minute, enter 60.0; and so on.

Code E

Field/Checkboxes Action Security Required

66 Publication SYSLIB-RM020C-EN-E - October 2011

Page 79: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Engineering Tab Page 3

Publication SYSLIB-RM020C-EN-E - October 2011 67

Page 80: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

The following table lists the functions on Engineering Tab Page 3.

Field/Checkboxes Action Security Required

Start & Stop Commands - Operator keeps control in Program Mode

Check this box to keep control of Dosing Commands (start totalizer, start flow, etc.) with the Operator, even if the instruction is in Program Mode.

Uncheck this box to have control of Dosing Commands follow the Instruction Mode.

Code E

Start & Stop Commands - Program keeps control in Operator Mode

Check this box to keep control of Dosing Commands (start totalizer, start flow, etc.) with the Program, even if the instruction is in Operator Mode.

Uncheck this box to have control of Dosing Commands follow the Instruction Mode

Code E

Setpoint - Operator keeps control in Program Mode

Check this box to keep control of the Setpoint Quantity setting with the Operator, even if the instruction is in Program Mode.

Uncheck this box to have control of the Setpoint Quantity setting follow the Instruction Mode

Code E

Setpoint - Program keeps control in Operator Mode

Check this box to keep control of the Setpoint Quantity setting with the Program, even if the instruction is in Operator Mode.

Uncheck this box to have control of the Setpoint Quantity setting follow the Instruction Mode

Code E

Dribble & Preact Settings - Program keeps control in Operator Mode

Check this box to keep control of the Dribble and Preact Quantity settings with the Operator, even if the instruction is in Program Mode.

Uncheck this box to have control of the Dribble and Preact Quantity settings follow the Instruction Mode

Code E

68 Publication SYSLIB-RM020C-EN-E - October 2011

Page 81: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Dribble & Preact Settings - Operator keeps control in Program Mode

Check this box to keep control of the Dribble and Preact Quantity settings with the Program, even if the instruction is in Operator Mode.

Uncheck this box to have control of the Dribble and Preact Quantity settings follow the Instruction Mode

Code E

High/Low Tolerances - Program keeps control in Operator Mode

Check this box to keep control of the High and Low Tolerance settings with the Operator, even if the instruction is in Program Mode.

Uncheck this box to have control of the High and Low Tolerance settings follow the Instruction Mode

Code E

High/Low Tolerances - Operator keeps control in Program Mode

Check this box to keep control of the High and Low Tolerance settings with the Program, even if the instruction is in Operator Mode.

Uncheck this box to have control of the High and Low Tolerance settings follow the Instruction Mode

Code E

Simulation Delivery Rate Enter the normal running delivery Rate that will be used when the P_DoseFM instruction is in Simulation (Inp_Sim = 1)

Code E

Simulation Dribble Weight Enter the dribble (slow) delivery Rate that will be used when the P_DoseFM instruction is in Simulation (Inp_Sim = 1)

Code E

Field/Checkboxes Action Security Required

Publication SYSLIB-RM020C-EN-E - October 2011 69

Page 82: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Trends Tab

On the Trends tab, users can view the Process Variable and reset the capture range’s min/max values. The green line represents the Process Variable (PV) and the light gray area shows the capture range.

Reset capture min/max value

70 Publication SYSLIB-RM020C-EN-E - October 2011

Page 83: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Alarm Configuration Tab

The Alarm Configuration tab contains configuration related to the alarms for the device.

Publication SYSLIB-RM020C-EN-E - October 2011 71

Page 84: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

The following table shows the function for the Alarm Configuration tab.

Check Box/Field Action Security Required

Alarm The alarm exists for the device. Code E

Acknowledge Required Require acknowledgement of the alarm.

IMPORTANT If using FTView Alarm and Events, configure its Alarm Tag for Acknowledge Required. The controller handles acknowledgement within this instruction

Code E

Reset Required Require a reset to clear the alarm status. There is a single alarm reset that resets all of the alarms for the device.

IMPORTANT If using FTView Alarm and Events, DO NOT check the "Latched" checkbox as the controller handles the alarm reset within this instruction.

Code E

Severity Configure the severity level of the alarm. Code E

Minimum On Time When an Alarm occurs, the Alarm output will be held on for at least this amount of time (sec). If set to 5 seconds or less, the Alarm output will be held on for at least 5 seconds to ensure it is seen by polling. Set this time higher if you want an Alarm to be held in the Alarm state (and on the Alarm summary) longer. This will keep it visible to the Operator, or keep the Alarm from clearing and being set again (for an intermittent condition) until the Operator has had time to perform any Alarm-related actions.

Note: If the alarm is configured with Reset Required (Cfg_ResetReqd = 1), the operator can reset the alarm before this time expires if the input condition has returned to normal.

Code D

72 Publication SYSLIB-RM020C-EN-E - October 2011

Page 85: P DoseFM 2.0 Syslib-rm020

HMI Reference Chapter 4

Flowmeter Dosing Faceplate Help

Publication SYSLIB-RM020C-EN-E - October 2011 73

Page 86: P DoseFM 2.0 Syslib-rm020

Chapter 4 HMI Reference

Notes:

74 Publication SYSLIB-RM020C-EN-E - October 2011

Page 87: P DoseFM 2.0 Syslib-rm020
Page 88: P DoseFM 2.0 Syslib-rm020

Rockwell Otomasyon Ticaret A.Ş., Kar Plaza İş Merkezi E Blok Kat:6 34752 İçerenköy, İstanbul, Tel: +90 (216) 5698400

Publication SYSLIB-RM020C-EN-E - October 2011Copyright © 2011 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.

Rockwell Automation Support

Rockwell Automation provides technical information on the Web to assist you in using its products. At http://www.rockwellautomation.com/support/, you can find technical manuals, a knowledge base of FAQs, technical and application notes, sample code and links to software service packs, and a MySupport feature that you can customize to make the best use of these tools.

For an additional level of technical phone support for installation, configuration, and troubleshooting, we offer TechConnectSM support programs. For more information, contact your local distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/support/.

Installation Assistance

If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact Customer Support for initial help in getting your product up and running.

New Product Satisfaction Return

Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.

Documentation Feedback

Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.

United States or Canada 1.440.646.3434

Outside United States or Canada Use the Worldwide Locator at http://www.rockwellautomation.com/support/americas/phone_en.html, or contact your local Rockwell Automation representative.

United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to your distributor to complete the return process.

Outside United States Please contact your local Rockwell Automation representative for the return procedure.

Power, Control and Information Solutions HeadquartersAmericas: Rockwell Automation, 1201 South Second Street, Milwaukee, WI 53204-2496 USA, Tel: (1) 414.382.2000, Fax: (1) 414.382.4444Europe/Middle East/Africa: Rockwell Automation NV, Pegasus Park, De Kleetlaan 12a, 1831 Diegem, Belgium, Tel: (32) 2 663 0600, Fax: (32) 2 663 0640Asia Pacific: Rockwell Automation, Level 14, Core F, Cyberport 3, 100 Cyberport Road, Hong Kong, Tel: (852) 2887 4788, Fax: (852) 2508 1846

www.rockwel lautomation.com