Rockwell Automation RM 200 Reference Manual

Download

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.

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

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

Weigh Scale Dosing (P_DoseWS) 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, publication

PlantPAx Distributed Control ystem Reference Manual, publication

Rockwell Automation Library of Process Objects, publication

FactoryTalk® View Machine Edition User Manual, publication

FactoryTalk View Site Edition User Manual, publication

Logix5000™ Controllers Add-On Instructions Programming Manual, publication

Rockwell Automation Library of Process Objects: Common Alarm Block (P_Alarm) Reference Manual, publication

SYSLIB-RM002

Rockwell Automation Library of Process Objects: Common Mode Block (P_Mode) Reference Manual, publication

SYSLIB-RM005

PROCES-SG001

PROCES-RM001

PROCES-RM002

VIEWME-UM004

VIEWSE-UM006

1756-PM010

Provides information to assist with equipment procurement for your PlantPAx system.

Provides characterized recommendations for implementing your PlantPAx system.

Provides general considerations for the PlantPAx system library of process objects.

Provides details on how to use this software package for creating an automation application.

Provides details on how to use this software package for developing and running human-machine interface (HMI) applications that can involve multiple users and servers, distributed over a network.

Provides information for designing, configuring, and programming Add-On Instructions.

Details how to monitor an input condition to raise an alarm. Information includes acknowledging, resetting, inhibiting, and disabling an alarm. Generally the P_Alarm faceplate is accessible from the Alarms tab.

Explains how to choose the Mode (owner) of an instruction or control strategy. The Mode instruction is 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, s bulk/dribble rate selection, preact, automatic preact adjustment,

such a and the ability to start, pause, and resume flow.

ou are measuring the quantity of ingredient added to a destination vessel

• Y

ain 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.

ou need to control precision blending. This instruction does not include

• Y capabil

ity for controlled-rate addition, such as ratio control, digital blending, or precision blending. Contact your Rockwell Automation representative for a blending solution.

ou need only a totalizer (integrator). Use the built-in TOT instruction

• Y instead.

ou need only to display a weigh scales’s weight or generate high and low

• Y weig

ht alarms. Use the P_AIn Analog Input Add-On Instruction instead.

You could need additional logic in these situations:

ou need more complicated sequencing, including special actions when

• Y 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.

he material transfer equipment requires complicated startup and

• T

tdown logic. You can provide this logic separately and use the

shu 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)

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.

ses a software tare of the scale to establish the zero-quantity starting

• U po

int 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.

rovides a rate of weight change calculation (differentiation with respect

• P time) to generate an inferred flow rate. The calculated rate is filtered and

to 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.

rovides outputs to control associated equipment, such as pumps and

• P

valves to start and stop flow. The operator or the program can start the ingredient addition, then pause and resume as needed.

onitors the status of controlled equipment, such as pumps and valves.

• M

ow is stopped and an alarm is raised on an equipment fault or if the

equipment fails to respond as commanded.

onitors the weight PV input quality and communication status and

• M

ovides indication of uncertain or bad weight PV. Flow is stopped and an

alarm is raised on a bad PV or communication loss.

rovides program or operator entry of a quantity to deliver (setpoint) and

• P

calcu

lates the quantity remaining to deliver and percent complete during

delivery.

Required Files

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

(RA-BAS) Process Diagnostic Objects (RA-BAS-ME) Process Diagnostic Objects Diagnostic global objects used on process object

(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

(RA-BAS) Process Graphics Library (RA-BAS-ME) Process Graphics Library Process global object device symbols used to build

(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.

faceplates.

process graphics

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

(RA-BAS) P_Alarm-Faceplate (RA-BAS-ME) P_Alarm-Faceplate The faceplate that is used for managing alarms for

(RA-BAS) P_Alarm-Help (RA-BAS-ME) P_Alarm-Help Alarm Help information that is accessed from the

(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

(RA-BAS) P_Mode-Help (RA-BAS-ME) P_Mode-Help Mode Help information that is accessed from the

(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

(RA-BAS) P_AIChan-Help (RA-BAS-ME) P_AIChan-Help Optional

View ME faceplates use the native analog input data entry so no file is required.

the object.

P_AIarm faceplate.

P_Mode object.

Help faceplate.

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.

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

where xx = the service release number.

These tags must be imported into the 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.

nfiguration data elements (Cfg_) are used to set configurable

• Co

capabil

ities and features of the instruction.

mmand data elements (PCmd_, OCmd_, MCmd_) are used by

• Co

ogram logic, operators, and maintenance personnel to request

instruction actions.

etting data elements (PSet_, OSet_, MSet_) are used by program logic,

• S

ope

rators, 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

Type

EnableIn BOOL 1 Ladder Diagram:

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

Inp_PVUncertain BOOL 0 Uncertain Quality for Inputs (1 = Uncertain, 0 = OK). This is optional status for the

Inp_CtrldEqpFault BOOL 0 Controlled equipment device or I/O status:

Inp_Sim BOOL 0 Simulation input. When set to 1, the instruction simulates a working dosing action.

Inp_Reset BOOL 0 Input parameter used to programmatically reset alarms. When set to 1, all alarms

Cfg_LossInWeight BOOL 0 1 = Running reduces weight (Transfer Out).

Cfg_HasDribble BOOL 0 1 = Slow to dribble before complete.

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

Alias For Default Description

If the rung-in condition is true, the instruction’s Logic routine executes. If the rungin 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.

read from an analog input, then this is normally read from the analog input channel fault status.

input that can be used to drive the status of the output (Sts_PVUncertain).

0 = OK 1 = Fail

When set to 0, the instruction controls dosing normally.

requiring reset are reset.

0 = Running increases weight (Transfer In).

0 = Run full flow until complete.

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

Weigh Scale Dosing (P_DoseWS)

Table 7 - P_DoseWS Input Parameters

Input Parameter Data

Type

Cfg_UseEqpFdbk BOOL 0 1 = Use run/dribble/stop feedback.

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

Cfg_HasChanObj BOOL 0 1 = Tells HMI a Channel object (P_AIChan, etc.) is used for Inp_WeightPV.

Cfg_PCmdClear BOOL Mode.Cfg_PCmdClear 1 When this parameter is 1, program commands are cleared once they are acted

Cfg_ProgDefault BOOL Mode.Cfg_ProgDefault 0 This parameter defines the default mode. When this parameter is 1, the mode

Cfg_ShedOnEqpFault BOOL 0 1 = Stop delivery and alarm on equipment fault.

Cfg_HasOverTolAlm BOOL OverTol.Cfg_Exists 0 These parameters determine whether the corresponding alarm exists and is

Cfg_HasUnderTolAlm UnderTol.Cfg_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.

Cfg_UnderTolResetReqd UnderTol.Cfg_ResetReqd

Cfg_TareFaultResetReqd TareFault.Cfg_ResetReqd

Cfg_EqpFaultResetReqd EqpFault.Cfg_ResetReqd

Cfg_OverTolAckReqd BOOL OverTol.Cfg_AckReqd 1 These parameters determine whether an acknowledgement is required for an

Cfg_UnderTolAckReqd UnderTol.Cfg_AckReqd

Cfg_TareFaultAckReqd TareFault.Cfg_AckReqd

Cfg_EqpFaultAckReqd EqpFault.Cfg_AckReqd

Alias For Default Description

0 = Assume equipment state.

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.

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’.

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.

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.

0 = Alarm only on Equipment fault.

checked or if the alarm does not exist and is not used. When these parameters are 1, the corresponding alarm exists.

When these parameters are 1, the alarm is latched ON when the alarm occurs. After 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 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 cleared when the alarm condition returns to normal.

IMPORTANT: If the reset clears the alarm, it also acknowledges the alarm.

alarm. When these parameters are 1, the acknowledge (ack) bit is cleared when 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 Acknowledge bit is set when an alarm occurs indicating an acknowledged alarm and no acknowledge command is required.

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

Table 7 - P_DoseWS Input Parameters

Weigh Scale Dosing (P_DoseWS)

Input Parameter Data

Type

Cfg_OverTolSeverity INT OverTol.Cfg_Severity 750 These parameters determine the severity of each alarm. This drives the colors and

Cfg_UnderTolSeverity UnderTol.Cfg_Severity 500

Cfg_TareFaultSeverity TareFault.Cfg_Severity 1000

Cfg_EqpFaultSeverity EqpFault.Cfg_Severity 1000

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.

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

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:

Cfg_ProgKeep SINT 2#0000_0000 Program keeps control in Operator mode:

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).

Alias For Default Description

symbols that are used to indicate alarm status on the faceplate and global object. The following are valid values: 1…250 = Low 251…500 = Medium 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.

IMPORTANT: The P_DoseWS instruction supports reverse scaling; either the raw (Input) or engineering (Scaled) range can be reversed (maximum less than minimum).

faulting.

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

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

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

Weigh Scale Dosing (P_DoseWS)

Table 7 - P_DoseWS Input Parameters

Input Parameter Data

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:

PCmd_Star

PCmd_St

PCmd_CheckT

PCmd_Bump BOOL 0 When PCmd_Bump is set to 1:

PCmd_Acq BOOL Mode.PCmd_Acq 0 When Cfg_PCmdClear is 1:

PCmd_Rel Mode

PCmd_Lock BOOL

PCmd_Unlock Mode

PCmd_Reset BOOL 0 • Set PCmd_Reset to 1 to reset all alarms requiring reset

PCmd_O

PCmd_Under

PCmd_Tar

PCmd_EqpFaultAck EqpFault.PCmd_Ack

tFlow BOOL 0 When Cfg_PCmdClear is 1:

opFlow

verTolAck BOOL OverTol.PCmd_Ack 0 • Set PCmd_<Alarm>Ack to 1 to Acknowledge alarm

TolAck UnderTol.PCmd_Ack

eFaultAck TareFault.PCmd_Ack

Type

Alias For Default Description

• Set PCmd_Tare to 1 to reset the delivered quantity to 0

• This parameter is reset automatically

When Cfg_PCmdClear is set to 0:

• S

et PCmd_Tare to 1 to reset the delivered quantity to 0

• This parameter is not reset automatically

• 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 reset automatically

When

Cfg_PCmdClear is 0:

• S

et 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

• If the configured bump time (Cfg_BumpT) is nonzero, then bump delivery for

the configur

– 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_Rel

Mode.PCmd_Lock 0 When Cfg_PCmdClear is 1:

.PCmd_Unlock

• Set PCmd_Acq to 1 to Acquire

• Set PCmd_Rel to 1 to Release

• These parameters reset automatically

When

• 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

• Set PCmd_Lock to 1 to Lock

• Set PCmd_Unlock to 1 to Unlock

• These parameters reset automatically

When

• 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

• This parameter is always reset automatically

• The parameter is reset automatically

ed bump time

Cfg_PCmdClear is 0:

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

Table 7 - P_DoseWS Input Parameters

Weigh Scale Dosing (P_DoseWS)

Input Parameter Data

PCmd_OverTolSuppress BOOL OverTol.PCmd_Suppress 0 When Cfg_PCmdClear is 1:

PCmd_Under

PCmd_Tar

PCmd_EqpFaultSuppress EqpFault.PCmd_Suppress

PCmd_OverTolUnsuppress BOOL OverTol.PCmd_Unsuppress 0

PCmd_UnderTolUnsuppress UnderTol.PCmd_Unsuppress

PCmd_TareFaultUnsuppress TareFault.PCmd_Unsuppress

PCmd_EqpFaultUnsuppress EqpFault.PCmd_Unsuppress

PCmd_OverTolUnshelve BOOL OverTol.PCmd_Unshelve 0 • S

PCmd_Under

PCmd_Tar

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

MCmd_Rel BOOL Mode.MCmd_Rel 0 Maintenance command to release ownership (Maintenance to Operator/Program/

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

TolSuppress UnderTol.PCmd_Suppress

eFaultSuppress TareFault.PCmd_Suppress

TolUnshelve UnderTol.PCmd_Unshelve

eFaultUnshelve TareFault.PCmd_Unshelve

Type

Alias For Default Description

• Set PCmd_<Alarm>Suppress to 1 to suppress alarm

• Set PCmd_<Alarm>Unsuppress to 1 to unsuppress alarm

• These parameters reset automatically

When Cfg_PCmdClear is 0:

• Set PCmd_<Alarm>Suppress to 1 to suppress alarm

• Set PCmd_<Alarm>Suppress to 0 to unsuppress alarm

• PCmd_<Alarm>Unsuppress is not used

• These Parameters do not reset automatically

et PCmd_<Alarm>Unshelve to 1 to Unshelve alarm

• The parameter is reset automatically

Maintenance).

Override)

conditions.

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

Weigh Scale Dosing (P_DoseWS)

Table 8 - P_DoseWS Output Parameters

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.

alue data elements (Val_) are numeric outputs of the instruction for

• V use b

y the HMI. Values can also be used by other application logic or

are packages.

softw

ource and Quality data elements (SrcQ_) are outputs of the instruction

• S use

d by the HMI to indicate PV source and quality.

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

• S HM

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

rror data elements (Err_) are outputs of the instruction that indicate a

• E par

ticular 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.

ot Ready data elements (Nrdy_) are bit outputs of the instruction for use

• N by the HMI for displaying the Device Not Ready indicator. Not Ready bits can also be used by other application logic.

larm data elements (Alm_) are outputs of the instruction that indicate a

• A par

ticular alarm has occurred.

cknowledge data elements (Ack_) are outputs of the instruction that

• A ind

icate the corresponding alarm has been acknowledged.

eady data elements (Rdy_) are bit outputs of the instruction used by

• R the H

MI to enable or disable command buttons and setting entry

fields.

Output Parameter Data Type Alias For Description

EnableOut BOOL Enable output: The EnableOut signal is not manipulated by this instruction. Its output 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

always reflects EnableIn input state.

Weigh Scale Dosing (P_DoseWS)

Table 8 - P_DoseWS Output Parameters

Output Parameter Data Type Alias For Description

Val_TolHi REAL Allowed quantity > or < SP (engineering units).

Val_TolLo

Val_PVEUMin REAL Minimum of scaled range = MIN (Cfg_PVEUMin, Cfg_PVEUMax).

Val_PVEUMax REAL Maximum of scaled range = MAX (Cfg_PVEUMin, Cfg_PVEUMax).

SrcQ_IO SINT I/O signal source and quality.

SrcQ Final dose source and quality.

GOOD 0 = I/O live and confirmed good quality

1 = I/O live and assumed good quality 2 = No feedback configured, assumed good quality

TEST 8 = Device simulated

9 = Device loopback simulation 10 = Manually entered value

UNCERTAIN 16 = Live input, off-specification

17 = Value substituted at device/bus 18 = Value substituted by maintenance (Has and not Use) 19 = Shed, using last good value 20 = Shed, using replacement value

BAD 32 = Signal failure (out-of-range, NaN, invalid combination)

33 = I/O channel fault 34 = I/O module fault 35 = Bad I/O configuration (for example, scaling parameters)

Val_Cmd SINT This shows the command being processed, returns to zero once the command secedes or fails.

Val_Fdbk SINT This shows the input from the device:

Val_Sts SINT This is the primary status, used to show the operator the ‘confirmed’ device status:

Val_Fault SINT This is the device fault status, used to show the operator the most severe device fault:

These values are also used for Inp_OvrdCmd: 0 = None

1 = Tare scale 3 = Start delivery 4 = Start dribble 5 = Bump 6 = Stop delivery

0 = None 1 = Stopped 2 = Delivering 3 = Dribbling

0 = Power up / reset 1 = Stopped 3 = Delivering 4 = Dribbling 5 = Bumping 6 = Start delivery 7 = Start dribble 8 = Stopping 33 = Disabled

0 = None 17 = Equipment fault 34 = Configuration error

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

Weigh Scale Dosing (P_DoseWS)

Table 8 - P_DoseWS Output Parameters

Output Parameter Data Type Alias For Description

Val_Mode SINT Mode.Val The shows the current mode of the object:

0 = No mode 2 = Maintenance 4 = Program (locked) 5 = Operator (locked) 6 = Program (unlocked, Operator is default) 7 = Operator (unlocked, Program is default) 8 = Program (unlocked, Program is default) 9 = Operator (unlocked, Operator is default)

Val_Owner DINT Current object owner ID (0 = not owned).

Val_Notify SINT Current alarm level and acknowledgement (enumeration):

0 = No alarm 1 = Alarm cleared: a reset or acknowledge is required 2 = Low (acknowledged) 3 = Low (unacknowledged) 4 = Medium (acknowledged) 5 = Medium (unacknowledged) 6 = High (acknowledged) 7 = High (unacknowledged) 8 = Urgent (acknowledged) 9 = Urgent (unacknowledged)

Sts_Tared BOOL Scale tare completed, Quantity = 0.

Sts_FlowStarting BOOL 1 = Flow is starting (Out_Run is on, feedback not showing run).

Sts_FlowRunning BOOL 1 = Flow is running (Out_Run is on, feedback showing run).

Sts_DribbleStarting BOOL 1 = Dribble starting (Out_Dribble is on, feedback not showing dribble).

Sts_FlowDribble BOOL 1 = Flow is slowed to dribble (Out_Dribble is on, feedback showing dribble).

Sts_FlowStopping BOOL 1 = Flow is stopping (Out_Stop is on, feedback not showing stopped).

Sts_FlowStopped BOOL 1 = Flow is Stopped (Out_Stop is on, feedback showing stopped).

Sts_Bumping BOOL 1 = Bump flow is active.

Sts_Complete BOOL 1 = Total delivered > (SP - preact).

Sts_InTol BOOL 1 = Total delivered is within tolerances.

Sts_Available BOOL 1 = Dosing available for control by automation (program).

Sts_PVBad BOOL 1 = Weight PV and rate PV quality bad (I/O fail).

0 = OK.

Sts_PVUncertain BOOL 1 = Weight PV and rate PV quality are uncertain.

0 = OK.

Sts_NotRdy BOOL 1 = Device is not ready to be operated.

Nrdy_CfgErr BOOL 1 = Device Not Ready:

Nrdy_PVBad

Nrdy_EqpF

Nrdy_NoMode

Sts_MaintByp BOOL 1 = A maintenance bypass is active, display icon.

Sts_AlmInh BOOL 1 = One or more alarms shelved, disabled or suppressed.

Sts_Err BOOL 1 = Error: bad configuration, see detail err bits for reason.

Err_Raw BOOL 1 = Error: Cfg_InpRawMax = Cfg_InpRawMin.

ault

• Configuration error

• PV bad quality or communication failure

• External equipment fault (fault or shed requires reset)

• Device logic disabled/no mode

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

Weigh Scale Dosing (P_DoseWS)

Table 8 - P_DoseWS Output Parameters

Output Parameter Data Type Alias For Description

Err_EU BOOL 1 = Error: Cfg_PVEUMax = Cfg_PVEUMin.

Err_Rate BOOL 1 = Error: Cfg_RateFiltTC or Cfg_RateTime invalid.

Err_Limit BOOL 1 = Error: Cfg_TareLim invalid (must be > 0.0).

Err_Qty BOOL 1 = Error: Cfg_MaxQty invalid (must be > 0.0).

Err_Sim BOOL 1 = Error: Cfg_SimDribbleRate or Cfg_SimRate invalid.

Err_Timer BOOL 1 = Error: Cfg_BumpT (use 0.0…2,147,483.647).

Err_Alarm BOOL 1 = Error: alarm minimum on time or severity configuration invalid.

Sts_Maint BOOL Mode.Sts_Maint 1 = Mode is Maintenance (supersedes Override, Program, Operator).

Sts_Prog BOOL Mode.Sts_Prog 1 = Mode is Program (auto).

Sts_Oper BOOL Mode.Sts_Oper 1 = Mode is Operator (manual).

Sts_ProgOperLock BOOL Mode.Sts_ProgOperLock 1 = Program or operator has requested mode lock.

Sts_NoMode BOOL Mode.Sts_NoMode 1 = No mode (disabled because EnableIn is false).

Sts_MAcqRcvd BOOL Mode.Sts_MAcqRcvd 1 = Maintenance acquire command received this scan.

Sts_OverTol BOOL OverTol.Inp 1 = Delivery out of tolerance high (excess).

Sts_UnderTol UnderTol.Inp 1 = Delivery out of tolerance low (short).

Sts_TareFault TareFault.Inp 1 = Scale reading moved unexpectedly since tare.

Sts_EqpFault EqpFault.Inp 1 = Equipment fault detected.

Alm_OverTol BOOL OverTol.Alm 1 = Delivery out of tolerance high (excess) alarm.

Alm_UnderTol UnderTol.Alm 1 = Delivery out of tolerance low (short) alarm.

Alm_TareFault TareFault.Alm 1 = Warning: scale reading moved since tare.

Alm_EqpFault EqpFault.Alm 1 = Alarm: Equipment fault (sensor or controlled equipment).

Ack_OverTol BOOL OverTol.Ack 1 = Over/Under Tolerance, Tare Fault, or Equipment Fault alarm acknowledged.

Ack_UnderTol UnderTol.Ack

Ack_TareFault TareFault.Ack

Ack_EqpFault EqpFault.Ack

Sts_OverTolDisabled BOOL OverTol.Disabled 1 = Over/Under Tolerance, Tare Fault, or Equipment Fault alarm disabled by maintenance.

Sts_UnderTolDisabled UnderTol.Disabled

Sts_TareFaultDisabled TareFault.Disabled

Sts_EqpFaultDisabled EqpFault.Disabled

Sts_OverTolShelved BOOL OverTol.Shelved 1 = Over/Under Tolerance, Tare Fault, or Equipment Fault alarm shelved by operator.

Sts_UnderTolShelved UnderTol.Shelved

Sts_TareFaultShelved TareFault.Shelved

Sts_EqpFaultShelved EqpFault.Shelved

Sts_OverTolSuppressed BOOL OverTol.Suppressed 1 = Over/Under Tolerance, Tare Fault, or Equipment Fault alarm suppressed by program.

Sts_UnderTolSuppressed UnderTol.Suppressed

Sts_TareFaultSuppressed TareFault.Suppressed

Sts_EqpFaultSuppressed EqpFault.Suppressed

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

Weigh Scale Dosing (P_DoseWS)

Table 8 - P_DoseWS Output Parameters

Output Parameter Data Type Alias For Description

Rdy_Tare BOOL 1 = Ready for OCmd Tare, StartFlow, StopFlow, CheckTol, or Bump (enables HMI button).

Rdy_StartFlow

Rdy_StopFlow

Rdy_CheckTol

Rdy_Bump

Rdy_Reset BOOL 1 = At least one alarm requires reset.

Rdy_ResetAckAll BOOL 1 = At least one alarm or latched shed condition requires reset or acknowledgement.

Rdy_SP BOOL 1 = Ready to receive OSet_SP.

Rdy_DribPre BOOL 1 = Ready to receive OSet_DribbleQty or OSet_Preact.

Rdy_Tol BOOL 1 = Ready to receive OSet_TolHi or OSet_TolLo.

P_DoseWS BOOL Unique parameter name for auto-discovery.

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

Weigh Scale Dosing (P_DoseWS)

Weigh Scale Dosing Local Configuration Tags

Configuration parameters that are arrayed, string, or structure data types cannot be configured as parameters for Add-On Instructions. Configuration parameters of these types appear as local tags to the Add-On Instruction. Local tags can be configured through the HMI faceplates or in Studio 5000 Logix Designer® application by opening the instruction logic of the Add-On Instruction instance and then opening the data monitor on a local tag. These parameters cannot be modified by using controller logic or Logix Designer export/import functionality.

Table 9 - P_DoseWS Local Configuration Tags

Tag Name Data Type Default Description

Cfg_Desc STRING_40 'Dosing with Weigh

Scale'

Cfg_Label STRING_20 'Weigh Scale Dosing' Label for graphic symbol displayed on HMI. This string appears on the graphic symbol.

Cfg_QtyEU STRING_8 'kg' Engineering units for quantity for display on HMI.

Cfg_RateEU STRING_8 'kg/sec' Engineering units for rate (flow) for display on HMI.

Cfg_Tag STRING_20 'P_DoseWS' Tagname for display on HMI. This string is shown in the title bar of the faceplate.

Description for display on HMI. This string is shown in the title bar of the faceplate.

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

Weigh Scale Dosing (P_DoseWS)

Operations

This section describes the primary operations for Add-On Instructions.

Modes

This instruction uses the following standard modes, which are implemented by using an embedded P_Mode Add-On Instruction.

Table 10 - Modes

Mode Description

Operator The Operator owns control of the device. Operator commands (OCmd_) and Operator settings

(OSet_) from the HMI are accepted.

Program Program logic owns control of the device. Program commands (PCmd_) and Program settings

(PSet_) are accepted.

Maintenance Maintenance owns control of the device and supersedes Operator, Program, and Override

control. Operator commands and settings from the HMI are accepted. Bypassable interlocks and permissives are bypassed, and device timeout checks are not processed.

No Mode The device is disabled and has no owner because the EnableIn input is false. The main

instruction Logic routine is not being scanned. See Execution section for more information on EnableInFalse processing.

IMPORTANT

Instructions with Cfg_OperKeep and Cfg_ProgKeep keep some aspects of the device operation with the operator or program regardless of whether the main mode is Program or Operator mode.

The following standard modes are not used:

• Hand mode

• Override (Ovrd) mode

See Rockwell Automation Library of Process Objects: Common Mode Block (P_Mode) Reference Manual, publication

SYSLIB-RM005, for more

information.

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

Weigh Scale Dosing (P_DoseWS)

Alarms

This instruction uses the following alarms, which are implemented by using embedded P_Alarm and P_Gate Add-On Instructions.

Alarm Name P_Alarm Name P_Gate Name Description

Equipment Fault EqpFault None Raised when the Inp_CtrldEqpFault input is true, or

Over tolerance OverTol None Raised when the tolerance check is performed and the

Tare Fault TareFault None Raised if the scale is tared, then the weight changes

Under Tolerance (Warning)

UnderTol None Raised when the tolerance check is performed and the

when equipment feedback signals fail to track the commanded state of the equipment within the configured time. If an equipment fault is configured as a shed fault, the flow is stopped and a reset is required to resume flow.

quantity delivered exceeds the setpoint by more than the High Tolerance threshold.

from the tare weight by more than the configured tare fault threshold (Cfg_TareFaultLim) before flow is commanded to start.

quantity delivered falls short of the setpoint by more than the Low Tolerance threshold.

TIP: In some instances, the Bump function can be used to make up the shortage.

Parameters of the P_Alarm object can be accessed by using the following convention: [P_Alarm Name].[P_Alarm Parameter].

See Rockwell Automation Library of Process Objects: Common Alarm Block (P_Alarm) Reference Manual, publication

SYSLIB-RM002, for more

information.

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

Weigh Scale Dosing (P_DoseWS)

Simulation

When the P_DoseWS block is placed in simulation, it continues to generate its outputs to control equipment, but the vessel weight is ignored and a simulated weight is generated.

This operation in simulation is different from the equipment (motor, valve, drive) instructions.

WARNING: To avoid starting equipment during simulation, the downstream equipment instructions must be put in simulation so that their outputs are held in the SAFE state. Failure to do this can result in personal injury or equipment damage.

Set the Inp_Sim parameter to ‘1’ to enable simulation.

The Simulation or Loopback Test icon is displayed at the bottom left of the faceplate to indicate the device is in simulation.

While in simulation, you can use the following parameters to control how the weight is simulated.

• Cfg_SimStartWt - when the Tare function is used, this value is copied to the simulated scale weight. As delivery occurs, the simulated weight increases (transfer in) or decreases (transfer out) from this point.

fg_SimRate - the full rate to be used for delivery (in weight units/rate

• C ti

me).

fg_SimDribbleRate - the rate to be used for dribble (in weight units/rate

• C ti

me).

When you have finished simulation, clear the Inp_Sim parameter to ‘0’ to return to normal operation.

Execution

The following table explains the handling of instruction execution conditions.

Condition Description

EnableIn false (false rung) Any commands received are discarded. All alarms are

Powerup (pre-scan, first scan) Any commands received before first scan are discarded.

Postscan (SFC transition) No SFC postscan logic is provided.

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.

Embedded P_Alarm instructions are handled in accordance with their standard powerup procedures. Refer to the reference manual for the P_Alarm instruction for more information.

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

Weigh Scale Dosing (P_DoseWS)

See the Logix5000 Controllers Add-On Instructions Programming Manual, publication

1756-PM010, for more information.

Programming Example

The following P_DoseWS example shows a simple configuration of the block with a two-speed motor (P_Motor2Spd).

The Input to P_DoseWS (Inp_WeightPV) is taken directly from a weight/force indicating transmitter (WIT_2). The outputs of the block (Out_RunFlow and Out_DribbleFlow) are connected to the inputs to the motor PCmd_RunFast and PCmd_RunSlow, respectively. The motor status outputs stopped (Sts_Stopped), running slow (Sts_RunningSlow), running fast (Sts_RunningFast) are connected back to the P_DoseWS block as inputs Inp_StopFdbk, Inp_RunFdbk, and Inp_DribbleFdbk.

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

Weigh Scale Dosing (P_DoseWS)

Display Elements

A display element (global object) is created once and can be referenced multiple times on multiple displays in an application. When changes are made to the original (base) object, the instantiated copies (reference objects) are automatically updated. Use of global objects, in conjunction with tag structures in the ControlLogix system, aid consistency and save engineering time.

Table 11 - P_DoseWS Display Elements Description

Display Element Name Display Element Description

GO_DoseWS Vertical orientation up.

GO_DoseWS1 Horizontal orientation right.

GO_DoseWS2 Horizontal orientation left.

Graphic objects are provided for use on end-user process graphic displays.

Common attributes of the P_DoseWS graphic symbols include the following:

• Graphical representation of the device

• Maintenance Bypass indicator

• Status/quality indicator

• Mode indicator

• Quantity and Scale Weight values

• Label

• State text

• Progress bar (percent complete)

• Quantity and Scale Weight Engineering Units

• Color changing alarm border that blinks on unacknowledged alarm

• Alarm indicator that changes color for the severity of the alarm

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

Weigh Scale Dosing (P_DoseWS)

Alarm Border

Alarm Indicator

Status/Quality

Indicator

Quantity Value

Current Scale Weight Value

Label

Scale

Symbol

Blue Progress

Bar (Percent

Complete)

State Indicator

Tex t

Maintenance Bypass Indicator

Device Not Ready Indicator

Mode Indicator

Delivered Quantity and Current Scale

Weight Engineering Units Text

The overall graphic symbol includes a touch field over it that opens 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.

Graphic Representation

The label changes color based on the highest severity alarm currently active.

Color Alarm Severity

Light blue Low alarm

Yellow Medium alarm

Red High alarm

Magenta Urgent alarm

Gray No active alarms

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

Weigh Scale Dosing (P_DoseWS)

The color of the weigh scale symbol and its state text change depending on the commanded state of the controlled equipment.

Color Equipment State

Dark Gray No flow (stopped)

White Running

Blue Dribble

Light Blue Bumping

Status/Quality Indicators

One of these symbols appears on the graphic symbol when the described condition is true.

Graphic Symbol Description

Invalid configuration.

Data quality bad/failure.

Data Quality degraded: uncertain, test, simulation, substitution, or out of specification.

The input or device has been disabled.

Device not ready to operate.

TIP

When the Invalid Configuration indicator appears, you can find what

configuration setting is invalid by following the indicators. Click the graphic symbol to open the faceplate. The Invalid Configuration indicator appears 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 is flagged with this indicator or appears in a magenta box.

For the Dosing with Weigh Scale Instruction, the Invalid Configuration Indicator appears under the following conditions:

• Weight Input Raw Minimum and Raw Maximum scaling parameters are set to the same value.

eight Scaled engineering units Minimum and engineering units

• W Ma

ximum scaling parameters are set to the same value.

ate Filter Time Constant value is less than zero.

• R

• Rate Time value is less than or equal to zero.

• Maximum Allowed Quantity Setpoint value is less than or equal to zero.

• Scale Tare Fault Limit value is less than zero.

• Simulation Starting Weight, Simulation Flow Rate, or Simulation Dribble

te value is less than or equal to zero.

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

Weigh Scale Dosing (P_DoseWS)

• Settle Time, Bump Time, Clear Pulse Time, or Equipment Fault Check Time is set to a value less than zero or greater than 2,147,483 seconds.

larm Minimum On Time is set to a value less than zero or greater than

• A 2,147,483 seconds

larm Severity is set to a value less than 1 or greater than 1000.

• A

TIP

When the Not Ready indicator appears, you can find what condition is

preventing operation by following the indicators. Click the graphic symbol to open the faceplate. The Not Ready indicator appears next to the appropriate tab at the top of the faceplate to guide you in finding the condition. When you navigate to the tab, the condition preventing operation is flagged.

r the Dosing with Weigh Scale instruction, the Device Not Ready indicator

ears under the following conditions:

app

here is a configuration error.

• T

• PV quality bad or communication error.

• External equipment fault and fault or shed requires reset.

Device logic is disabled or there is no mode.

Mode Indicators

One of these symbols appears on the right side of the graphic symbol to indicate the mode of the object instruction.

Graphic Symbol Description

Transparent Operator mode (if the default mode is Operator and the current mode is Operator, the mode

indicator is transparent).

Operator mode (if the default mode is Program).

Operator mode locked.

Transparent Program mode (if the default mode is Program and the current mode is Program, the mode

indicator is transparent).

Program mode (if the default mode is Operator).

Program mode locked.

Maintenance mode.

No mode.

See Rockwell Automation Library of Process Objects: Common Mode Block (P_Mode) Reference Manual, publication

SYSLIB-RM005, for more

information.

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

Weigh Scale Dosing (P_DoseWS)

Alarm Indicators

One of these symbols appears on the left side of the label to indicate the described alarm condition and the alarm border and label background change color. The alarm border and label background blink if acknowledgement of an alarm condition is required. Once the alarm is acknowledged, the alarm border and label background remain the color that corresponds to the severity of the alarm.

Symbol Border and Label Background Description

No change in color Alarm Inhibit: an alarm is suppressed by the Program,

disabled by Maintenance, or shelved by the Operator.

White Return to normal (no alarm condition), but a previous

Blue Low severity alarm.

Yellow Medium severity alarm.

Red High severity alarm.

Magenta Urgent severity alarm.

No symbol No change in color No alarm or alarm inhibit condition, and all alarms

alarm has not been acknowledged.

are acknowledged.

See Rockwell Automation Library of Process Objects: Common Alarm Block (P_Alarm) Reference Manual, publication

SYSLIB-RM002, for more

information.

Maintenance Bypass Indicator

This symbol appears to the right of the label to indicate that a maintenance bypass has been activated.

TIP

When the Maintenance Bypass Indicator appears, you can find what condition

was bypassed by following the indicators. Click the Graphic Symbol to open the Faceplate. The Maintenance Bypass Indicator appears next to the appropriate tab at the top of the Faceplate to guide you in finding the bypass. Once you navigate to the tab, the bypassed item is flagged with this indicator.

For the P_DoseWS Instruction, the Maintenance Bypass Indicator appears when the instruction is configured by engineering to have equipment feedback, but maintenance personnel have selected to not use the equipment feedback.

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

Weigh Scale Dosing (P_DoseWS)

Use Global Objects

The graphic symbol for P_DoseWS can be found in the global object file (RA-BAS) Process Graphics Library.ggfx.

1. Copy the global object from the global object file and paste it in the display file.

2. In the display, right-click the global object and choose Global Object Para

meter Values.

The Global Object Parameter Values dialog box appears.

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

Weigh Scale Dosing (P_DoseWS)

The global object parameters are as follows.

Parameter Required Description

#102 Y Object tag to point to the name of the associated object Add-On

#103 Y Path used for display navigation features to other objects. Include

#120 N Additional parameter to pass to the display command to open the

#121 N Additional parameter to pass to the display command to open the

#122 Y These are the options for the global object display:

Instruction in the controller.

program scope if tag is a program scope tag.

faceplate. Typically used to define position for the faceplate.

faceplate. If defining X and Y coordinate, separate parameters so that X is defined by #120 and Y is defined by #121. This lets the same parameters to be used in subsequent display commands originating from the faceplate.

0 = Always show faceplate 1 = Show Quick Display for users without Maintenance access

(Code C) 2 = Always show Quick Display

3. Type the tag or value in the Value column as specified in the Description colu

mn.

4. C

TIP

lick OK.

Click the ellipsis (. . .) to browse and choose a tag.

Values for items marked ‘(optional)’ can be left blank.

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

Weigh Scale Dosing (P_DoseWS)

Quick Display

The Quick Display screen provides the means for operators to perform simple interactions with the P_DoseWS instruction instance. From the Quick Display, you can navigate to the faceplate for full access for operation, maintenance, and configuration.

Navigate to Full Faceplate Button

Faceplate

The weigh scale dosing faceplate consists of six tabs and each tab consists of one or more pages.

The title bar of each faceplate contains the value of local configuration tags Cfg_Tag and Cfg_Desc.

The Operator tab is displayed when the faceplate is initially opened. Click the appropriate icon at the top of the faceplate to access a specific tab.

Maintenance

Operator Engineering

Diagnostics Alarms

Trends

Help

Exit

The faceplate provides the means for operators, maintenance personnel, engineers, and others to interact with the P_DoseWS 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.

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

Weigh Scale Dosing (P_DoseWS)

Operator Tab

The Faceplate initially opens to the Operator (‘Home’) tab. From here, an operator can monitor the device status and manually operate the device when it is in Operator mode.

The Operator tab shows the following information:

• Current mode (Operator, Program, or Maintenance)

• Requested modes indicator (appears only if the Operator or Program

mode h section for more information.)

• D or Com

• Qu

• Quantity delivered display

• Delivery rate display

• Tolerance check result indicator (in tolerance, over tolerance, or under

• Eq dribble, or bu

• Qu

• Input Source and Quality indicator (See 'SrcQ' in the Output parameters

as been superseded by another mode; see the Maintenance tab

elivery progress bar if delivering, or the delivery status (Tared, Complete,

plete at Zero)

antity remaining to deliver display

olerance; this appears after performing a tolerance check)

uipment commanded state indicator, for example, stopped, running,

mping

antity setpoint data entry field

page 19 for details).

ble on

TIP

The Tolerance Indicator shows if the delivery was in tolerance, under tolerance,

or over tolerance. This indicator is visible only when a tolerance check has been requested after delivery is complete.

If 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

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

Mode Indicator

Weigh Scale Dosing (P_DoseWS)

Reset Acknowledge All Alarms Command Buttons

Delivery Progress Bar

Tolerance Indicator

Scale Weight

Dosing Equipment Commanded State

Indicator

Input Source and Quality Indicator

Input Source and

Quality Icon

Operator Mode Unlock and Lock Command Buttons

Tare Scale Command Button

Start Flow Command Button

Check Tolerance Command Button

Bump Flow Command Button

Stop Flow Command Button

The following table shows the functions on the Operator tab.

Table 12 - Operator Tab Description

Button/Field Action Security

Click to release Operator mode Lock. Manual device

Click to lock in Operator mode.

Click to request Program mode.

Click to request Operator mode.

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

operation (code B)

Weigh Scale Dosing (P_DoseWS)

Table 12 - Operator Tab Description

Button/Field Action Security

Click to reset and acknowledge all alarms. Acknowledge alarms

(code F)

Click to tare the scale. This sets the delivered quantity to zero.

Click to start or resume delivery.

Click to stop (pause) delivery.

Click to perform a tolerance check on the delivered quantity.

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.

Setpoint quantity Configure the quantity to deliver.

Normal operation of devices (code A)

Alarm indicators appear on the Operator tab when the corresponding alarm occurs.

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

Tare Fault Alarm

Over Tolerance Alarm

Under Tolerance Alarm

Equipment Fault Alarm

Weigh Scale Dosing (P_DoseWS)

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.

Table 13 - Alarm Status Indicators

Graphic Object Alarm Status

In alarm (active alarm)

In alarm and acknowledged

Out of alarm but not acknowledged

Alarm suppressed (by program)

Alarm disabled (by maintenance)

Alarm shelved (by operator)

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

Weigh Scale Dosing (P_DoseWS)

Maintenance Tab

Maintenance personnel use the information and controls on the Maintenance tab to make adjustments to device parameters, troubleshoot and temporarily work around device problems, and disable the device for routine maintenance.

The Maintenance is divided into two pages.

Maintenance Tab Page 1

Page one of the Maintenance tab shows the following information:

• Current mode (Operator, Program, or Maintenance)

• Requested modes indicator highlights all of the modes that have been

uested, and the left-most highlighted mode is the active mode

urrent high tolerance value

• C

• Current low tolerance value

• Dribble quantity data entry field

• Preact quantity data entry field

Mode Indicator

Requested Modes Indicator

Input Signal from

Weigh Scale

Maintenance Mode Acquire and Release Command Buttons

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

Weigh Scale Dosing (P_DoseWS)

The following table shows the functions on page one of the Maintenance tab.

Table 14 - Maintenance Tab Page 1 Description

Button/Field Action Security Configuration Parameters

Click to request Maintenance mode. Equipment

maintenance (code C)

Click to release Maintenance mode.

None

Raw Weight Input (Pounds)

Dribble quantity (Pounds))

Preact quantity (Pounds)

Delivery Tolerance over Setpoint

Delivery Tolerance below Setpoint

Click to open an upstream channel object faceplate (for example, P_AIChan).

IMPORTANT: 'Enable navigation to Weight input object' on page 2 of the Engineering tab must be enabled for this field to be displayed.

Engineering Tab Page 2 on

(See

page 47.)

Configure the quantity in pounds left to deliver before switching to a reduced flow rate (dribble) for finer control of the final quantity.

Configure the quantity before reaching the setpoint before commanding the delivery equipment to stop and let the equipment react. This helps to prevent overshooting the delivery setpoint.

Type the high tolerance threshold. When a tolerance check is initiated, if the delivered quantity exceeds the setpoint amount by more than this amount, the delivery is over tolerance; the over tolerance alarm is raised if enabled.

Type the low tolerance threshold. When a tolerance check is initiated, if the delivered quantity falls short of the setpoint amount 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.

Normal operation of Devices (code A)

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

Weigh Scale Dosing (P_DoseWS)

Table 14 - Maintenance Tab Page 1 Description

Button/Field Action Security Configuration Parameters

Use Equipment Feedback

Bumpless Program/ Operator Transition

Check to use the available feedback from the delivery equipment and take the device out of Maintenance Bypass.

Clear this checkbox to not use feedback from the delivery equipment and place the device in Maintenance Feedback.

IMPORTANT: 'Delivery Equipment has Feedback' on page 2 of the Engineering tab must be enabled for this field to be visible. (See

Engineering Tab Page 2 on

page 47.)

Check to enable or disable bumpless program/operator transition of quantity setpoint, dribble quantity, preact and tolerance Threshold settings (tracking).

Equipment maintenance (code C)

Cfg_UseEqpFdbk

Cfg_SetTrack

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

Maintenance Tab Page 2

Weigh Scale Dosing (P_DoseWS)

The following table lists the functions of page two of the Maintenance tab.

Table 15 - Maintenance Tab Page 2 Description

Button/Field Action Security Configuration Parameters

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

Amount (Pounds) scale can drift after Tare before starting flow without faulting

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

Type the percentage of delivery error. 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 lets the preact self-tune and learn the correct value of the preact over time.

Type the tare fault threshold. After the scale is tared and before flow is commanded, if the weight reported by the scale drifts from the tare weight by more than this amount, a tare fault alarm is raised.

Configuration & tuning maintenance (Code D)

Cfg_AutoAdjPct

Cfg_TareFaultLim

Weigh Scale Dosing (P_DoseWS)

Table 15 - Maintenance Tab Page 2 Description

Button/Field Action Security Configuration Parameters

Duration of flow when Bump is pressed (seconds)

Time after output for equipment feedback before Fault (seconds)

Delay after flow stop before enabling tolerance check (seconds)

Type 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, Bump 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.

Type the maximum allowed feedback time.

If equipment feedback is being used, the instruction allows this much time after commanding the equipment for feedback to show the equipment in the commanded state before raising a fault status.

Type the amount of time in seconds after flow is stopped for the scale reading to settle before a tolerance check can be commanded.

Configuration & tuning maintenance (Code D)

Cfg_BumpT

Cfg_Fault

Cfg_SettleT

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

Weigh Scale Dosing (P_DoseWS)

Engineering Tab

The Engineering tab provides access to device configuration parameters and ranges, options for device and I/O setup, displayed text, and faceplate-to-faceplate navigation settings, for initial system commissioning, or later system changes.

The Engineering tab is divided into three pages.

Engineering Tab Page 1

On page 1 of the Engineering tab, you can configure the description, label, tag, weigh scale input scaling and units, and rate units for the device.

Page Control Navigation

Mode Configuration Button

Device Description, Label, and Tag

Rate Units

Scaling And Units for Weigh Scale Input

Units

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

Weigh Scale Dosing (P_DoseWS)

The following table lists the functions on page 1 of the Engineering tab.

Table 16 - Engineering Tab Page 1 Description

Function Action Security Configuration

Click to navigate to the Configuration Mode display.

Description Type the device description to be used on the

Label Type the device label to be used on the graphic

Tag Type the tagname to be used on the title bar of

Rate units Type the engineering units text for the rate of

Input Weight PV Scaling: Raw maximum and minimum input

Input Weight PV Scaling: Scaled maximum and minimum input

Units Type the engineering units text for the weight

Auto adjust preact after each delivery

Running reduces weight (transfer out)

faceplate title bar.

symbol.

the operator faceplate and in the Tooltip.

delivery.

Type the minimum and maximum values for

the raw Input from the weigh scale. These values are used for scaling from raw to engineering units.

Type the minimum and maximum values for

the scaled input from the weigh scale in engineering Units. These values are used for scaling from raw to engineering units.

from the scale.

Check to automatically adjust the preact based on the actual vs. setpoint quantity after each successful delivery.

Clear this checkbox to leave the preact as entered.

Check if the weight on the scale decreases as delivery proceeds (material is transferred out of the vessel being weighed).

Clear this checkbox if the weight on the scale increases as delivery proceeds (material is transferred into the vessel being weighed).

Engineering configuration (code E)

Parameters

See Mode Configuration display on

Cfg_Desc

Cfg_Label

Cfg_Tag

Cfg_RateEU

• Cfg_InpRawMin

• Cfg_InpRawMax

• Cfg_PVEUMin

• Cfg_PVEUMax

Cfg_QtyEU

Cfg_AutoAdjPreact

Cfg_LossInWeight

page 46

Mode Configuration Display

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

Weigh Scale Dosing (P_DoseWS)

This display lets you select the default mode for the object by selecting the appropriate mode.

IMPORTANT

If no mode is being requested, changing the default mode changes the mode of the instruction.

You must have FactoryTalk View security code E to select the default mode on this display.

Engineering Tab Page 2

The following table lists the functions on page 2 of the Engineering tab.

Table 17 - Engineering Tab Page 2 Description

Function Action Security Configuration Parameters

Slow to dribble before complete

Clear program commands on receipt

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

Check to have the equipment commanded to a slower dribble rate as delivery nears completion to improve the accuracy of quantity delivered.

Check to clear program commands on receipt.

Engineering configuration (code E)

Cfg_HasDribble

Cfg_PCmdClear

Weigh Scale Dosing (P_DoseWS)

Table 17 - Engineering Tab Page 2 Description

Function Action Security Configuration Parameters

Delivery Equipment has Feedback

Stop Delivery on Equipment Fault

Enable navigation to Weight Input object

Maximum allowed quantity to deliver (setpoint)

Filter time constant for calculated rate (seconds)

Time factor for rate (e.g., 60 for /min or 3600 for /hr) (seconds)

Check, if the controlled equipment provides feedback of its running, dribbling, and stopped status to this instruction. This instruction checks that the equipment is performing the commanded function and provides a status (and optional alarm) if the equipment fails to respond as commanded within a configurable time.

TIP: The feedback fault time is configured on the Maintenance tab, page 2.

When checked, 'Use Equipment Feedback' on page 1 of the Maintenance tab is available. (See

Maintenance Tab Page 1 on

page 40.)

Clear this checkbox if the controlled equipment does not provide feedback of its status. The instruction assumes the equipment is performing the commanded function and no equipment failure-to-respond checking occurs.

Check 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).

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

Check to enable navigation to the Raw Weight’s Input channel object faceplate.

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’.

Enter the maximum allowed quantity to deliver. The quantity setpoint is clamped to not exceed this value.

Enter the filter time constant for calculated 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.

Engineering configuration (code E)

Cfg_HasEqpFdbk

Cfg_ShedOnEqpfault

Cfg_HasChanObj

Cfg_MaxQty

Cfg_RateFiltTC

Cfg_RateTime

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

Engineering Tab Page 3

Weigh Scale Dosing (P_DoseWS)

The following table lists the functions on page 3 of the Engineering tab.

Table 18 - Engineering Tab Page 3 Description

Function Action Security Configuration Parameters

Operator keeps control in program mode: Start & stop commands

Program keeps control in operator mode: Start & stop commands

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

Check to keep control of dosing commands, such as tare and start flow, with the operator, even if the instruction is in Program mode.

Clear this checkbox to have control of dosing commands follow the Instruction mode.

Check to keep control of dosing commands, such as tare and start flow, with the program, even if the instruction is in Operator mode.

Clear this checkbox to have control of dosing commands follow the Instruction mode.

Engineering configuration (code E)

Cfg_OperKeep.0

Cfg_ProgKeep.0

Weigh Scale Dosing (P_DoseWS)

Table 18 - Engineering Tab Page 3 Description

Function Action Security Configuration Parameters

Operator keeps control in Program mode: Setpoint

Program keeps control in Operator mode: Setpoint

Operator keeps control in Program mode: Dribble and preact settings

Program keeps control in Operator mode: Dribble and preact settings

Operator keeps control in Program mode: High/low tolerances

Program keeps control in Operator mode: High/low tolerances

Delivery rate in Loopback Test (Rate units)

Dribble rate in Loopback Test (Rate units)

Tare Weight in Loopback Test (Rate units)

Check to keep control of the setpoint quantity setting with the operator, even if the instruction is in Program mode.

Clear this checkbox to have control of the setpoint quantity setting follow the Instruction mode.

Check to keep control of the setpoint quantity setting with the program, even if the instruction is in Operator mode.

Clear this checkbox to have control of the setpoint quantity setting follow the Instruction mode.

Check to keep control of the dribble and preact quantity settings with the operator, even if the instruction is in Program mode.

Clear this checkbox to have control of the dribble and preact quantity settings follow the Instruction mode.

Check to keep control of the dribble and preact quantity settings with the program, even if the instruction is in Operator mode.

Clear this checkbox to have control of the dribble and preact quantity settings follow the Instruction mode.

Check to keep control of the high and low tolerance settings with the operator, even if the instruction is in Program mode.

Clear this checkbox to have control of the high and low tolerance settings follow the Instruction mode.

Check to keep control of the high and low tolerance settings with the program, even if the instruction is in Operator mode.

Clear this checkbox to have control of the high and low tolerance settings follow the Instruction mode.

Enter the normal running delivery rate that is used when the P_DoseWS instruction is in simulation (Inp_Sim = 1).

Enter the dribble (slow) delivery rate that is used when the P_DoseWS instruction is in simulation (Inp_Sim = 1).

Enter the weight that appears on the scale after a tare when the P_DoseWS instruction is in simulation (Inp_Sim = 1).

Engineering configuration (code E)

Cfg_OperKeep.1

Cfg_ProgKeep.1

Cfg_OperKeep.2

Cfg_ProgKeep.2

Cfg_OperKeep.3

Cfg_ProgKeep.3

Cfg_SimRate

Cfg_SimDribbleRate

Cfg_SimStartWt

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

Weigh Scale Dosing (P_DoseWS)

Diagnostics Tab

The Diagnostic tab provides indications that are helpful in diagnosing or preventing device problems, which can include specific reasons a device is 'Not Ready', device warnings and faults, warning and fault history, and predictive/ preventive maintenance data.

The Diagnostics tab displays possible reasons the device is not ready.

The previous image indicates that the PV has bad quality or there is a communication failure.

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

Weigh Scale Dosing (P_DoseWS)

Trends Tab

The Trends Tab shows trend charts of key device data over time. These faceplate trends provide a quick view of current device performance to supplement, but not replace, dedicated historical, or live trend displays.

The Trends tab is divided into 2 pages.

Trends Tab Page 1

(Green) Delivery Rate

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

(Green) Delivery Quantity

Weigh Scale Dosing (P_DoseWS)

Trends Tab Page 2

(Blue) Setpoint

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

Weigh Scale Dosing (P_DoseWS)

Device Not

Ready Indicator

Alarm Names

Alarms Tab

The Alarms Tab shows all the available alarms for the device and their current status. From here, Alarms can be acknowledged and reset. Click an alarm name to open the alarm detail faceplate for that alarm where the alarm can be shelved by the operator, disabled by maintenance, or configured by engineering.

Alarm Severity Indicators

Acknowledge Alarm Command Button

Reset and Acknowledge All Alarms Command Button

Click an alarm name to open the P_Alarm faceplate for that alarm. From the P_Alarm faceplate, you can configure and perform additional operations on the alarm.

If an alarm is active, the panel behind the alarm changes color to match the severity of the alarm. The color of the bell icon at the top of the faceplate shows the severity of the highest active alarm, and the icon blinks if any alarm is unacknowledged or requires reset.

Table 19 - Alarm Severity Colors

Color Definition

Magenta Urgent

Red High

Yellow Medium

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

Weigh Scale Dosing (P_DoseWS)

Table 19 - Alarm Severity Colors

Color Definition

Blue Low

White (bell icon) Alarm has cleared but is unacknowledged

Background (Light Gray) No alarm

The following table shows the functions on the Alarms tab.

Table 20 - Alarms Tab Description

Function Action Security

Alarm Name Click an alarm name to open the associated

P_Alarm faceplate.

Click to acknowledge the alarm. Acknowledge Alarms

Click to reset and acknowledge all alarms.

None

(Code F)

When the Reset and Acknowledge All Alarms button is enabled, the panel behind the alarm blinks, indicating the alarm requires acknowledgement or reset. The Alarm Acknowledge button is enabled if the alarm requires acknowledgment. Click the button with the check mark to acknowledge the alarm.

See Rockwell Automation Library of Process Objects: Common Alarm Block (P_Alarm) Reference Manual, publication

SYSLIB-RM002, for

more information.

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

Weigh Scale Dosing (P_DoseWS)

Weigh Scale Dosing Drive Faceplate Help

The Faceplate Help is divided into two pages.

Faceplate Help Page 1

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

Faceplate Help Page 2

Weigh Scale Dosing (P_DoseWS)

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

Weigh Scale Dosing (P_DoseWS)

Notes:

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

Rockwell Automation Support

Rockwell Automation provides technical information on the Web to assist you in using its products.

http://www.rockwellautomation.com/support you can find technical and application notes, sample code, and links to

At software service packs. You can also visit our Support Center at updates, support chats and forums, technical information, FAQs, and to sign up for product notification updates.

In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more information, contact your local distributor or Rockwell Automation representative, or visit

http://www.rockwellautomation.com/services/online-phone.

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.

United States or Canada 1.440.646.3434

Outside United States or Canada Use the

Worldwide Locator at http://www.rockwellautomation.com/rockwellautomation/support/overview.page, or contact your local

Rockwell Automation representative.

New Product Satisfaction Return

https://rockwellautomation.custhelp.com/ for software

Rockwell Automation tests all of its products to help 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.

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

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

distributor to complete the return process.

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

Rockwell Automation maintains current product environmental information on its website at

http://www.rockwellautomation.com/rockwellautomation/about-us/sustainability-ethics/product-environmental-compliance.page.

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

RA-DU002, available at http://www.rockwellautomation.com/literature/.

Publication SYSLIB-RM021G-EN-E - February 2017

Rockwell Automation RM 200 Reference Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Rockwell Automation Library of Process Objects: Weigh Scale Dosing (P_DoseWS)

Important User Information

Table of Contents

Preface

Software Compatibility and Content Revision

Additional Resources

Weigh Scale Dosing (P_DoseWS)

Guidelines

Functional Description

Required Files

Controller File

Visualization Files

Controller Code

Weigh Scale Dosing Input Structure

Weigh Scale Dosing Output Structure

Weigh Scale Dosing Local Configuration Tags

Operations

Modes

Alarms

Simulation

Execution

Programming Example

Display Elements

Graphic Representation

Status/Quality Indicators

Mode Indicators

Alarm Indicators

Maintenance Bypass Indicator

Use Global Objects

Quick Display

Faceplate

Operator Tab

Maintenance Tab

Engineering Tab

Diagnostics Tab

Trends Tab

Alarms Tab

Weigh Scale Dosing Drive Faceplate Help