Rockwell Automation RM 200 Reference Manual

Reference Manual

Rockwell Automation Library of Process Objects: Weigh Scale

Dosing (P_DoseWS)

Version 3.5

	IMPORTANT	This manual applies to the Rockwell Automation Library of Process Objects version 3.5 or earlier.
		For Rockwell Automation Library of Process Objects version 5.0, see
		• PROCES-RM200
		For Rockwell Automation Library of Process Objects version 4.0 or later, use the following manuals:
		• PROCES-RM013 contains logic instructions
		• PROCES-RM014 contains display elements

Important User Information

Read this document and the documents listed in the additional resources section about installation, configuration, and operation of this equipment before you install, configure, operate, or maintain this product. Users are required to familiarize themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws, and standards.

Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to be carried out by suitably trained personnel in accordance with applicable code of practice.

If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be impaired.

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

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and diagrams.

No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this manual.

Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.

Throughout this manual, when necessary, we use notes to make you aware of safety considerations.

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

ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.

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

Labels may also be on or inside the equipment to provide specific precautions.

SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be present.

BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous temperatures.

ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).

Allen-Bradley, Rockwell Software, and Rockwell Automation are trademarks of Rockwell Automation, Inc. Trademarks not belonging to Rockwell Automation are property of their respective companies.

Table of Contents

Preface

Weigh Scale Dosing (P_DoseWS)

Software Compatibility and Content Revision. . . . . . . . . . . . . . . . . . . . 5

Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Weigh Scale Dosing Input Structure . . . . . . . . . . . . . . . . . . . . . . . . 13

Weigh Scale Dosing Output Structure . . . . . . . . . . . . . . . . . . . . . . 18

Weigh Scale Dosing Local Configuration Tags . . . . . . . . . . . . . . . 23

Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Graphic Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Use Global Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Quick Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Trends Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Weigh Scale Dosing Drive Faceplate Help . . . . . . . . . . . . . . . . . . . 56

Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

3

Table of Contents

Notes:

4	Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

Preface

Software Compatibility and

Content Revision

Table 1 - Summary of Changes

Topic	Page
Visualization Files: Global Objects (.ggfx) - Process Diagnostic Objects	11

For the latest compatible software information and to download the Rockwell

Automation® Library of Process Objects, see the Product Compatibility and

Download Center at http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.

For general library considerations, see Rockwell Automation Library of Process Objects, publication PROCES-RM002.

Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

5

Preface

Additional Resources

These documents contain additional information concerning related products from Rockwell Automation.

Resource	Description
PlantPAx® Distributed Control System Selection Guide,	Provides information to assist with equipment
publication PROCES-SG001	procurement for your PlantPAx system.
PlantPAx Distributed Control ystem Reference Manual,	Provides characterized recommendations for
publication PROCES-RM001	implementing your PlantPAx system.
Rockwell Automation Library of Process Objects,	ProvidesgeneralconsiderationsforthePlantPAxsystem
publication PROCES-RM002	library of process objects.
FactoryTalk® View Machine Edition User Manual,	Provides details on how to use this software package for
publication VIEWME-UM004	creating an automation application.
FactoryTalk View Site Edition User Manual,	Provides details on how to use this software package for
publication VIEWSE-UM006	developing and running human-machine interface
	(HMI) applications that can involve multiple users and
	servers, distributed over a network.
Logix5000™ Controllers Add-On Instructions Programming	Provides information for designing, configuring, and
Manual, publication 1756-PM010	programming Add-On Instructions.
Rockwell Automation Library of Process Objects: Common	Details how to monitor an input condition to raise an
Alarm Block (P_Alarm) Reference Manual, publication	alarm. Information includes acknowledging, resetting,
SYSLIB-RM002	inhibiting, and disabling an alarm. Generally the
	P_Alarm faceplate is accessible from the Alarms tab.
Rockwell Automation Library of Process Objects: Common	Explains how to choose the Mode (owner) of an
Mode Block (P_Mode) Reference Manual, publication	instruction or control strategy. The Mode instruction is
SYSLIB-RM005	usually embedded within other instructions to extend
	their functionality. It is possible to use a standalone
	Mode instruction to enhance a program where modes
	are wanted.

You can view or download publications at http:/www.rockwellautomation.com/literature/. To order paper copies of technical documentation, contact your local Allen-Bradley distributor or

Rockwell Automation sales representative.

6	Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

Weigh Scale Dosing (P_DoseWS)

The P_DoseWS (Weigh Scale Dosing) Add-On Instruction controls an ingredient addition that uses a weigh scale to measure the quantity of ingredient added. The weigh scale can be on the receiving vessel (gain in weight) or on the sourcing vessel (loss in weight). The weigh scale can be connected via an analog input, device network, or other connection.

Global Object

Faceplate

Add-On Instruction

Guidelines

Use this instruction in these situations:

•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 quantity of ingredient added to a destination vessel (gain in weight) or the quantity transferred from a source vessel (loss in weight) by using a weigh scale. The scale provides a weight value and can be interfaced via an analog input card, network, or other means.

Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

7

Weigh Scale Dosing (P_DoseWS)

Do not use this instruction in these situations:

•You want to measure the quantity of ingredients transferred with a flowmeter. Use the P_DoseFM 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 need only a totalizer (integrator). Use the built-in TOT instruction instead.

•You need only to display a weigh scales’s weight or generate high and low weight alarms. Use the P_AIn Analog Input Add-On Instruction instead.

You could need additional logic in these situations:

•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_DoseWS instruction by using its Program mode commands and settings.

•The material transfer equipment requires complicated startup and shutdown logic. You can provide this logic separately and use the

P_DoseWS outputs to trigger the logic for startup and shutdown of ingredient delivery.

8	Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

Weigh Scale Dosing (P_DoseWS)

Functional Description

The following diagram shows the functional characteristics of the P_DoseWS Add-On Instruction.

Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

9

Weigh Scale Dosing (P_DoseWS)

Required Files

The P_DoseWS instruction provides the following capabilities:

•Provides linear scaling of the input weight value from raw (input card) units to engineering (display) units.

•Uses a software tare of the scale to establish the zero-quantity starting point for transfer. Once the scale is tared, the instruction checks for unrequested flow, that is, an increase or decrease in scale weight before flow is actually started, and raises a tare fault alarm if such a weight change occurs.

•Provides a rate of weight change calculation (differentiation with respect to time) to generate an inferred flow rate. The calculated rate is filtered and has a low cutoff, so the rate is reported as zero when the change in weight is only from noise on the input weight signal.

•Provides outputs to control associated equipment, such as pumps and valves to start and stop flow. The operator or the program can start the ingredient addition, then pause and resume as needed.

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

•Monitors the weight PV input quality and communication status and provides indication of uncertain or bad weight 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 quantity remaining to deliver and percent complete during delivery.

Add-On Instructions are reusable code objects that contain encapsulated logic that can streamline implementing your system. This lets you create your own instruction set for programming logic as a supplement to the instruction set provided natively in the ControlLogix® firmware. An Add-On Instruction is defined once in each controller project, and can be instantiated multiple times in your application code as needed.

Controller File

The P_DoseWS_3_5-00_AOI.L5X Add-On Instruction must be imported into the controller project to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created.

10	Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

Weigh Scale Dosing (P_DoseWS)

Visualization Files

This Add-On Instruction has associated visualization files that provide a common user interface. These files can be downloaded from the Product

Compatibility and Download Center at http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.

IMPORTANT	The visualization file dependencies require Process Library content imports to
	occur in a specific order as reflected in the following tables:
	•	Images
	•	Global Objects
	•	Standard Displays
	•	HMI Tags
	•	Macros

Images are external graphic files that can be used in displays. They must be imported for FactoryTalk View to make use of them.

When PNG files are imported, they are renamed by FactoryTalk View with a .bmp file extension, but retain a .png format.

Table 2 - Visualization Files: Images (.png)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
All .png files in the images folder	All .png files in the images folder	These are the common icons used in the global objects and
		standard displays for all Process Objects.

The Global Object files (.ggfx file type) in the following table are Process Library display elements that are created once and referenced multiple times on multiple displays in an application. When changes are made to a Global Object, all instances in the application are automatically updated.

Table 3 - Visualization Files: Global Objects (.ggfx)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
(RA-BAS) Common Faceplate Objects	(RA-BAS-ME) Common Faceplate Objects	Global objects used on process object faceplates.
(RA-BAS) Process Alarm Objects	(RA-BAS-ME) Process Alarm Objects	Global objects used for managing alarms on process
		object	faceplates.
(RA-BAS) Process Diagnostic Objects	(RA-BAS-ME) Process Diagnostic Objects	Diagnostic global objects used on process object
		faceplates.
(RA-BAS) Process Faceplate Analog Objects	(RA-BAS-ME) Process Faceplate Analog Objects	Analog global objects used on process object faceplates.
(RA-BAS) Process Faceplate Misc Objects	(RA-BAS-ME) Process Faceplate Misc Objects	Miscellaneous global objects used on process object
		faceplates.
(RA-BAS) Process Graphics Library	(RA-BAS-ME) Process Graphics Library	Process global object device symbols used to build
		process	graphics
(RA-BAS) Process Help Objects	(RA-BAS-ME) Process Help Objects	Global objects used for all process objects help displays.
(RA-BAS) Process Mode Objects	(RA-BAS-ME) Process Mode Objects	Global objects used for managing modes on process
		object	faceplates.

The Standard Display files (.gfx file type) in the following table are the Process

Library displays that you see at runtime.

Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

11

Weigh Scale Dosing (P_DoseWS)

Table 4 - Visualization Files: Standard Displays (.gfx)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
(RA-BAS) Common-AnalogEdit	N/A	Faceplate used for analog input data entry.The FactoryTalk
		View ME faceplates use the native analog input data entry
		so no file is required.
(RA-BAS) P_Alarm-Faceplate	(RA-BAS-ME) P_Alarm-Faceplate	The faceplate that is used for managing alarms for
		the	object.
(RA-BAS) P_Alarm-Help	(RA-BAS-ME) P_Alarm-Help	Alarm Help information that is accessed from the
		P_AIarm		faceplate.
(RA-BAS) P_DoseWS-Faceplate	(RA-BAS-ME) P_DoseWS-Faceplate	The faceplate that is used for the object
(RA-BAS) P_DoseWS-Quick	(RA-BAS-ME) P_DoseWS-Quick	The Quick display that is used for the object
(RA-BAS) P_Mode-Config	(RA-BAS-ME) P_Mode-Config	The Configuration Display used to configure the
		P_Mode		object.
(RA-BAS) P_Mode-Help	(RA-BAS-ME) P_Mode-Help	Mode Help information that is accessed from the
		Help	faceplate.
(RA-BAS) Process Dose Family-Help	(RA-BAS-ME) Process Dose Family-Help	The Help display for Dose objects
(RA-BAS) P_AIChan-Faceplate	(RA-BAS-ME) P_AIChan-Faceplate	Optional
		The Channel faceplate used for the object.
		Use this file if your Analog Input has an associated
		P_AIChan object and you enable navigation to its
		faceplate from the Analog Input faceplate.
(RA-BAS) P_AIChan-Help	(RA-BAS-ME) P_AIChan-Help	Optional
		Channel Help information that is accessed from the
		P_AIChan Help faceplate.
		Use this file if you use the Analog Input Channel faceplate.

HMI Tags are created in a FactoryTalk View ME application to support tab switching on Process Library faceplates. The HMI tags may be imported via the comma-separated values file (.csv file type) in the following table.

Table 5 - Visualization Files: HMI Tags (.csv)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
N/A	FTVME_PlantPAxLib_Tags_3_5_xx.csv	These tags must be imported into the
	where xx = the service release number.	FactoryTalk View ME project to support switching tabs on
		any Process Object faceplate.

12	Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

Weigh Scale Dosing (P_DoseWS)

Controller Code

This section describes the parameter references for this Add-On Instruction.

Weigh Scale Dosing Input Structure

Input parameters include the following:

•Input data elements (Inp_) are typically used to connect field inputs from I/O modules or signals from other objects.

•Configuration data elements (Cfg_) are used to set configurable capabilities and features of the instruction.

•Command data elements (PCmd_, OCmd_, MCmd_) are used by program logic, operators, and maintenance personnel to request instruction actions.

•Setting data elements (PSet_, OSet_, MSet_) are used by program logic, operators, and maintenance personnel to establish runtime setpoints, thresholds, and so forth. Set_ data elements (without a leading P, O, or M) establish runtime settings regardless of role or mode.

Table 7 - P_DoseWS Input Parameters

Input Parameter	Data	Alias For	Default	Description
	Type
EnableIn	BOOL		1	Ladder Diagram:
				If the rung-in condition is true, the instruction’s Logic routine executes. If the rung-
				in condition is false, the instruction’s EnableInFalse routine executes.
				Function Block Diagram:
				If true, or not connected, the instruction’s Logic routine executes. If the parameter
				is exposed as a pin and wired, and the pin is false, the instruction’s EnableInFalse
				routine executes.
				Structured Text:
				No effect. The instruction’s Logic routine executes.
Inp_WeightPV	REAL		0.0	Weight from weigh scale (unscaled).
Inp_RunFdbk	BOOL		0	1	= Controlled equipment is delivering (running).
Inp_DribbleFdbk	BOOL		0	1	= Controlled equipment is delivering at dribble.
Inp_StopFdbk	BOOL		0	1	= Controlled equipment is confirmed stopped.
Inp_PVBad	BOOL		0	Bad Signal Quality/Communication Status for Inputs (1 = Bad, 0 = OK). If PV is
				read from an analog input, then this is normally read from the analog input
				channel fault status.
Inp_PVUncertain	BOOL		0	Uncertain Quality for Inputs (1 = Uncertain, 0 = OK). This is optional status for the
				input that can be used to drive the status of the output (Sts_PVUncertain).
Inp_CtrldEqpFault	BOOL		0	Controlled equipment device or I/O status:
				0	= OK
				1	= Fail
Inp_Sim	BOOL		0	Simulation input.When set to 1, the instruction simulates a working dosing action.
				When set to 0, the instruction controls dosing normally.
Inp_Reset	BOOL		0	Input parameter used to programmatically reset alarms. When set to 1, all alarms
				requiring reset are reset.
Cfg_LossInWeight	BOOL		0	1	= Running reduces weight (Transfer Out).
				0	= Running increases weight (Transfer In).
Cfg_HasDribble	BOOL		0	1	= Slow to dribble before complete.
				0	= Run full flow until complete.
Cfg_HasEqpFdbk	BOOL		0	1	= Controlled Equipment provides Run, Dribble (if used), and Stop Feedback.

Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

13

Weigh Scale Dosing (P_DoseWS)

Table 7 - P_DoseWS Input Parameters

Input Parameter	Data	Alias For	Default	Description
	Type
Cfg_UseEqpFdbk	BOOL		0	1 = Use run/dribble/stop feedback.
				0 = Assume equipment state.
Cfg_AutoAdjPreact	BOOL		0	1 = Enable automatic adjustment of preact after each tolerance check.
Cfg_SetTrack	BOOL		1	This parameter is used to set up bumpless behavior of setting parameters when
				switching modes. When this parameter is 1, in Program mode the operator
				settings track the program settings; in Operator mode the program settings track
				the operator settings; and the simulation inputs match the output values
				(transitions are bumpless).
				When this parameter is 0, the operator settings and program settings are not
				modified by this instruction. In this case, when the mode is changed, the effective
				value of the setting can change depending on the program-set and operator-set
				values.
Cfg_HasChanObj	BOOL		0	1 = Tells HMI a Channel object (P_AIChan, etc.) is used for Inp_WeightPV.
				IMPORTANT: The name of the Channel object in the controller must be this
				object's name with the suffix ‘_Chan’. For example, if your P_DoseWS object has
				the name ‘DoseWS123’, then its Channel object must be named
				‘DoseWS123_Chan’.
Cfg_PCmdClear	BOOL	Mode.Cfg_PCmdClear	1	When this parameter is 1, program commands are cleared once they are acted
				upon. When set to 0, program commands remain set until cleared by the
				application program logic.
				IMPORTANT: Clearing this parameter online can cause unintended program
				command execution.
Cfg_ProgDefault	BOOL	Mode.Cfg_ProgDefault	0	This parameter defines the default mode. When this parameter is 1, the mode
				defaults to Program if no mode is being requested. When this parameter is 0, the
				mode defaults to Operator if no mode is being requested.
				IMPORTANT: Changing this parameter online can cause unintended mode
				changes.
Cfg_ShedOnEqpFault	BOOL		0	1 = Stop delivery and alarm on equipment fault.
				0 = Alarm only on Equipment fault.
Cfg_HasOverTolAlm	BOOL	OverTol.Cfg_Exists	0	These parameters determine whether the corresponding alarm exists and is
				checked or if the alarm does not exist and is not used. When these parameters are
Cfg_HasUnderTolAlm		UnderTol.Cfg_Exists
				1, the corresponding alarm exists.
Cfg_HasTareFaultAlm		TareFault.Cfg_Exists
Cfg_HasEqpFaultAlm		EqpFault.Cfg_Exists
Cfg_OverTolResetReqd	BOOL	OverTol.Cfg_ResetReqd	0	These parameters determine whether a reset is required to clear the alarm status.
				When these parameters are 1, the alarm is latched ON when the alarm occurs. After
Cfg_UnderTolResetReqd		UnderTol.Cfg_ResetReqd
				the alarm condition returns to normal, a reset is required to clear the alarm status
				(for example, OCmd_Reset, Inp_Reset, or EqpFault.OCmd_Reset are required to
Cfg_TareFaultResetReqd		TareFault.Cfg_ResetReqd
				clear Alm_EqpFault alarm after the alarm is set and the equipment returns to
				normal). When these parameters are 0, no reset is required and the alarm status is
Cfg_EqpFaultResetReqd		EqpFault.Cfg_ResetReqd
				cleared when the alarm condition returns to normal.
				IMPORTANT: If the reset clears the alarm, it also acknowledges the alarm.
Cfg_OverTolAckReqd	BOOL	OverTol.Cfg_AckReqd	1	These parameters determine whether an acknowledgement is required for an
				alarm. When these parameters are 1, the acknowledge (ack) bit is cleared when
Cfg_UnderTolAckReqd		UnderTol.Cfg_AckReqd
				the alarm occurs. An acknowledge command (for example, PCmd_EqpFaultAck or
				EqpFault.OCmd_Ack) is required to acknowledge the alarm. When set to 0, the
Cfg_TareFaultAckReqd		TareFault.Cfg_AckReqd
				Acknowledge bit is set when an alarm occurs indicating an acknowledged alarm
				and no acknowledge command is required.
Cfg_EqpFaultAckReqd		EqpFault.Cfg_AckReqd

14	Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

					Weigh Scale Dosing (P_DoseWS)
Table 7 - P_DoseWS Input Parameters
Input Parameter	Data		Alias For	Default	Description
	Type
Cfg_OverTolSeverity	INT		OverTol.Cfg_Severity	750	These parameters determine the severity of each alarm. This drives the colors and
					symbols that are used to indicate alarm status on the faceplate and global object.
Cfg_UnderTolSeverity			UnderTol.Cfg_Severity	500
					The following are valid values:
Cfg_TareFaultSeverity			TareFault.Cfg_Severity	1000	1…250 = Low
					251…500 = Medium
Cfg_EqpFaultSeverity			EqpFault.Cfg_Severity	1000
					501…750 = High
					751…1000 = Urgent
					IMPORTANT: For FactoryTalk View software version 7.0, these severity parameters
					drive only the indication on the global object and faceplate. The Alarms and Events
					definition of severity drives the color and symbol that is used on the alarm banner
					and alarm summary as well as the value returned by FactoryTalk Alarms and Events
					display commands.
Cfg_InpRawMin	REAL			0.0	Minimum unscaled weight input.
Cfg_InpRawMax	REAL			10000.0	Maximum unscaled weight input.
Cfg_PVEUMin	REAL			0.0	Minimum scaled weight PV input (engineering units).
Cfg_PVEUMax	REAL			10000.0	PV (Output) maximum for scaling to engineering units.
					IMPORTANT: The P_DoseWS instruction supports reverse scaling; either the raw
					(Input) or engineering (Scaled) range can be reversed (maximum less than
					minimum).
Cfg_MaxQty	REAL			1.0E+38	Maximum allowed quantity to deliver (setpoint) (engineering units).
Cfg_RateTime	REAL			1.0	Time factor for rate (60 for /min, 3600 for /hr) (seconds).
Cfg_RateFiltTC	REAL			0.1	Filter time constant (seconds) for calculated rate.
Cfg_TareFaultLim	REAL			1.0	Amount (engineering units) scale can drift after tare before starting flow without
					faulting.
Cfg_SettleT	REAL			1.0	Time to allow scale to settle before allowing tolerance check (seconds).
Cfg_BumpT	REAL			0.0	Bump (manual top-off) Time (seconds), 0.0 = use Bump command as a ‘jog’.
Cfg_AutoAdjPct	REAL			10.0	Percentage of delivery error to auto-adjust preact (%).
Cfg_SimStartWt	REAL			0.0	Weight to start from (tare to) in simulation (engineering units).
Cfg_SimRate	REAL			1.0	Rate at which to deliver when running in simulation (engineering units/rate time).
Cfg_SimDribbleRate	REAL			0.1	Rate at which to dribble when running in simulation (engineering units/rate time).
Cfg_FaultT	DINT			10	Time for equipment feedback to follow output before fault (seconds).
Cfg_OperKeep	SINT			2#0000_0000	Operator keeps control in Program mode:
					Bit .0 = 1 operator keeps Start/Stop
					Bit .1 = 1 Operator keeps SP
					Bit .2 = 1 Operator keeps Dribble/preact
					Bit .3 = 1 Operator keeps Tolerances
Cfg_ProgKeep	SINT			2#0000_0000	Program keeps control in Operator mode:
					Bit .0 = 1 Program keeps Start/Stop
					Bit .1 = 1 Program keeps SP
					Bit .2 = 1 Program keeps Dribble/preact
					Bit .3 = 1 Program keeps Tolerances
PSet_SP	REAL			0.0	Program setting of total quantity to deliver (engineering units).
PSet_DribbleQty					Program setting of quantity to dribble (engineering units).
PSet_Preact					Program setting of quantity before total to stop flow (engineering units).
PSet_TolHi					Program setting of high (excess) tolerance limit.
PSet_TolLo					Program setting of low (shortage) tolerance limit.
PSet_Owner	DINT			0	Program owner request ID (nonzero) or Release (zero).

Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

15

Weigh Scale Dosing (P_DoseWS)

Table 7 - P_DoseWS Input Parameters

Input Parameter	Data	Alias For	Default	Description
	Type
OSet_SP	REAL		0.0	Operator setting of total quantity to deliver (engineering units).
OSet_DribbleQty				Operator setting of quantity to dribble (engineering units).
OSet_Preact				Operator setting of quantity before total to stop flow (engineering units).
OSet_TolHi				Operator setting of high (excess) tolerance limit.
OSet_TolLo				Operator setting of low (shortage) tolerance limit.
PCmd_Tare	BOOL		0	When Cfg_PCmdClear is 1:
				• Set PCmd_Tare to 1 to reset the delivered quantity to 0
				• This parameter is reset automatically
				When Cfg_PCmdClear is set to 0:
				• Set PCmd_Tare to 1 to reset the delivered quantity to 0
				• This parameter is not reset automatically
PCmd_StartFlow	BOOL		0	When Cfg_PCmdClear is 1:
				• Set PCmd_StartFlow to 1 to start delivery
PCmd_StopFlow
				• Set PCmd_StopFlow to 1 to stop delivery
PCmd_CheckTol				• Set PCmd_CheckTolerances to 1 to check tolerances
				• These parameters reset automatically
				When Cfg_PCmdClear is 0:
				• Set PCmd_StartFlow to 1 to start delivery
				• Set PCmd_StopFlow to 1 to stop delivery
				• Set PCmd_CheckTolerances to 1 to check tolerances
				• These parameters do not reset automatically
PCmd_Bump	BOOL		0	When PCmd_Bump is set to 1:
				• If the configured bump time (Cfg_BumpT) is nonzero, then bump delivery for
				the configured bump time
				– PCmd_Bump is cleared automatically
				• If the configured bump time (Cfg_BumpT) is zero, then bump delivery until
				PCmd_Bump is returned to 0
				– PCmd_Bump is not cleared automatically
				• Cfg_PCmdClear does not affect this parameter
PCmd_Acq	BOOL	Mode.PCmd_Acq	0	When Cfg_PCmdClear is 1:
				• Set PCmd_Acq to 1 to Acquire
PCmd_Rel		Mode.PCmd_Rel
				• Set PCmd_Rel to 1 to Release
				• These parameters reset automatically
				When Cfg_PCmdClear is 0:
				• Set PCmd_Acq to 1 to Acquire
				• Set PCmd_Acq to 0 to Release
				• PCmd_Rel is not used
				• These parameters do not reset automatically
PCmd_Lock	BOOL	Mode.PCmd_Lock	0	When Cfg_PCmdClear is 1:
				• Set PCmd_Lock to 1 to Lock
PCmd_Unlock		Mode.PCmd_Unlock
				• Set PCmd_Unlock to 1 to Unlock
				• These parameters reset automatically
				When Cfg_PCmdClear is 0:
				• Set PCmd_Lock to 1 to Lock
				• Set PCmd_Lock to 0 to Unlock
				• PCmd_Unlock is not used
				• These parameters do not reset automatically
PCmd_Reset	BOOL		0	• Set PCmd_Reset to 1 to reset all alarms requiring reset
				• This parameter is always reset automatically
PCmd_OverTolAck	BOOL	OverTol.PCmd_Ack	0	• Set PCmd_<Alarm>Ack to 1 to Acknowledge alarm
				• The parameter is reset automatically
PCmd_UnderTolAck		UnderTol.PCmd_Ack
PCmd_TareFaultAck		TareFault.PCmd_Ack
PCmd_EqpFaultAck		EqpFault.PCmd_Ack

16	Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

Weigh Scale Dosing (P_DoseWS)

Table 7 - P_DoseWS Input Parameters

	Input Parameter	Data	Alias For	Default	Description
		Type
	PCmd_OverTolSuppress	BOOL	OverTol.PCmd_Suppress	0	When Cfg_PCmdClear is 1:
					• Set PCmd_<Alarm>Suppress to 1 to suppress alarm
	PCmd_UnderTolSuppress		UnderTol.PCmd_Suppress
					• Set PCmd_<Alarm>Unsuppress to 1 to unsuppress alarm
	PCmd_TareFaultSuppress		TareFault.PCmd_Suppress		• These parameters reset automatically
					When Cfg_PCmdClear is 0:
	PCmd_EqpFaultSuppress		EqpFault.PCmd_Suppress
					• Set PCmd_<Alarm>Suppress to 1 to suppress alarm
	PCmd_OverTolUnsuppress	BOOL	OverTol.PCmd_Unsuppress	0
					• Set PCmd_<Alarm>Suppress to 0 to unsuppress alarm
					• PCmd_<Alarm>Unsuppress is not used
	PCmd_UnderTolUnsuppress		UnderTol.PCmd_Unsuppress
					• These Parameters do not reset automatically
	PCmd_TareFaultUnsuppress		TareFault.PCmd_Unsuppress
	PCmd_EqpFaultUnsuppress		EqpFault.PCmd_Unsuppress
	PCmd_OverTolUnshelve	BOOL	OverTol.PCmd_Unshelve	0	• Set PCmd_<Alarm>Unshelve to 1 to Unshelve alarm
					• The parameter is reset automatically
	PCmd_UnderTolUnshelve		UnderTol.PCmd_Unshelve
	PCmd_TareFaultUnshelve		TareFault.PCmd_Unshelve
	PCmd_EqpFaultUnshelve		EqpFault.PCmd_Unshelve
	OCmd_Tare	BOOL		0	Operator command to tare (reset delivered quantity to 0).
	OCmd_StartFlow	BOOL		0	Operator commands to start delivery, stop/pause delivery, or check tolerances.
	OCmd_StopFlow
	OCmd_CheckTol
	OCmd_Bump	BOOL		0	Operator command to bump delivery for under tolerance.
	MCmd_Acq	BOOL	Mode.MCmd_Acq	0	Maintenance command to acquire ownership (Operator/Program/Override to
					Maintenance).
	MCmd_Rel	BOOL	Mode.MCmd_Rel	0	Maintenance command to release ownership (Maintenance to Operator/Program/
					Override)
	OCmd_AcqLock	BOOL	Mode.OCmd_AcqLock	0	Operator command to acquire (Program to Operator)/lock ownership.
	OCmd_Unlock	BOOL	Mode.OCmd_UnlockRel	0	Operator command to unlock/release (Operator to Program) ownership.
	OCmd_Reset	BOOL		0	Operator command to reset all alarms requiring reset.
	OCmd_ResetAckAll	BOOL		0	Operator command to acknowledge and reset all alarms and latched shed
					conditions.

Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017

17

Weigh Scale Dosing (P_DoseWS)

Weigh Scale Dosing Output Structure

Output parameters include the following:

•Output data elements (Out_) are the primary outputs of the instruction, typically used by hardware output modules; however, they can be used by other application logic.

•Value data elements (Val_) are numeric outputs of the instruction for use by the HMI. Values can also be used by other application logic or software packages.

•Source and Quality data elements (SrcQ_) are outputs of the instruction used by the HMI to indicate PV source and quality.

•Status data elements (Sts_) are bit outputs of the instruction for use by the

HMI. Status bits can also be used by other application logic.

•Error data elements (Err_) are outputs of the instruction that indicate a particular configuration error. If any Err_ bit is set, then the Sts_Err configuration error summary status is set and the Invalid Configuration indicator is displayed on the HMI.

•Not Ready data elements (Nrdy_) are bit outputs of the instruction for use by the HMI for displaying the Device Not Ready indicator. Not Ready bits can also be used by other application logic.

•Alarm data elements (Alm_) are outputs of the instruction that indicate a particular alarm has occurred.

•Acknowledge data elements (Ack_) are outputs of the instruction that indicate the corresponding alarm has been acknowledged.

•Ready data elements (Rdy_) are bit outputs of the instruction used by the HMI to enable or disable command buttons and setting entry fields.

Table 8 - P_DoseWS Output Parameters

Output Parameter	Data Type	Alias For	Description
EnableOut	BOOL		Enable output: The EnableOut signal is not manipulated by this instruction. Its output state
			always reflects
			EnableIn input state.
Out_RunFlow	BOOL		1 = Deliver at full (fast) flow.
Out_DribbleFlow	BOOL		1 = Deliver at dribble (slow) flow.
Out_StopFlow	BOOL		1 = Stop delivery equipment.
Val_PV	REAL		Weight on scale (engineering units).
Val_Tare	REAL		Weight on scale when tare command received (engineering units).
Val_Qty	REAL		Quantity actually delivered (change in weight) (engineering units).
Val_Rate	REAL		Current delivery rate (engineering units/time).
Val_SP	REAL		Quantity to be delivered (setpoint) (engineering units).
Val_Remain	REAL		Quantity yet to deliver to reach setpoint (engineering units).
Val_PctComplete	REAL		Percent complete (for progress bar on HMI) 0.0…100.0%.
Val_DribbleQty	REAL		Quantity to be delivered at slow rate (engineering units).
Val_Preact	REAL		Quantity before SP when flow is stopped (engineering units).

18	Rockwell Automation Publication SYSLIB-RM021G-EN-E - February 2017