Rockwell Automation n-Position Device Reference Manual

Reference Manual

Rockwell Automation Library of Process Objects: n-Position Device (P_nPos)

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 Software Compatibility and Content Revision. . . . . . . . . . . . . . . . . . . . 5

Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

n-Position Device (P_nPos) Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

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

Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

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

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

n-Position Device Input Structure . . . . . . . . . . . . . . . . . . . . . . . . . . 13

n-Position Device Output Structure . . . . . . . . . . . . . . . . . . . . . . . . 18

n-Position Device Local Configuration Tags . . . . . . . . . . . . . . . . . 23

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

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

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

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

Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

State Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Using Display Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Quick Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

n-Position Device Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017 3

Table of Contents

Notes:

4 Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017

Preface

Software Compatibility and Content Revision

Additional Resources

Table 1 - Summary of Changes

Topic Page

Visualization Files: Global Objects (.ggfx) - Process Diagnostic Objects 12

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.

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

Resource Description

PlantPAx® Distributed Control System Selection Guide,
publication

PlantPAx Distributed Control System Reference Manual,
publication

Rockwell Automation Library of Process Objects,
publication

FactoryTalk® View Machine Edition User Manual,
publication

FactoryTalk View SE 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: Interlocks
with First Out and Bypass (P_Intlk) Reference Manual,
publication

SYSLIB-RM004

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

SYSLIB-RM005

Rockwell Automation Library of Process Objects: Permissives
with Bypass (P_Perm) Reference Manual, publication

SYSLIB-RM007

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 collect (sum up) the interlock
conditions that stop or de-energize a running or
energized piece of equipment or prevent it from
starting or being energized.

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.

Details how to collect permissive conditions to start a
piece of equipment.

Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017 5

Preface

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-RM031E-EN-P - February 2017

n-Position Device (P_nPos)

The P_nPos (n-Position Device) Add-On Instruction controls a circular or linear
discrete device with 2…8 positions. The P_nPos instruction provides outputs to
select an individual position and outputs to move toward increasing positions
(‘clockwise’ for a circular device) or decreasing positions (‘counterclockwise’ for a
circular device).

For linear devices, the P_nPos instruction can be configured to return to
Position 1 on every move, approaching the target position from the ‘same side’ on
each move to improve position repeatability, or move directly to the new
position.

For circular devices, the P_nPos instruction can be configured to move only
‘clockwise’ to increase positions (for example, 6, 7, 8, 1, 2…) or both directions by
using the shortest move (for example, ‘clockwise’ from 6…1: 6, 7, 8, 1; or
‘counterclockwise’ from 2…7: 2, 1, 8, 7).

Faceplate

Add-On Instruction

Global Objects

Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017 7

n-Position Device (P_nPos)

The P_nPos instruction also supports devices with a locking or sealing capability.
It can unlock or unseal the device, move to the new position, then lock or seal in
position.

The P_nPos instruction accepts position feedback (usually proximity or limit
switches) and can alarm on failure to reach a target position in a configured time.
When the locking/sealing capability is used, a lock/seal feedback can be provided
and lock/unlock checking can also be performed.

The global objects and preceding faceplate are examples of the graphical interface
tools for this Add-On Instruction.

Guidelines

Use this instruction in these situations:

• You want to control the position of a device with 2…8 discrete positions.

• The device accepts commands for the individual positions, increase and

decrease position commands, or indexing cylinder commands.

Do not use this instruction in these situations:

• You want to control a simple two-state valve or two-state or three-state
motor. The P_ValveMO (Motor Operated Valve), P_ValveSO (Solenoid
Operated Valve), P_ValveMP (Mix Proof Valve), P_Motor (Single Speed
Motor), P_Motor2Spd (Two Speed Motor), or P_MotorRev (Reversing
Motor) instruction provides a better interface and better ‘model’ for such a
device.

• You have a continuously variable position device. The P_nPos instruction
works only with devices that have 2…8 discrete positions. For most final
control elements that are used in process control, a P_AOut (Analog
Output) or P_ValveC (Control Valve) instruction is a better choice. For
high-speed motion control, such as with servo drives, use the Motion
Control instruction set provided within the Logix controller firmware.

8 Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017

n-Position Device (P_nPos)

Functional Description

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

Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017 9

n-Position Device (P_nPos)

The n-Position Device instruction provides the following capabilities:

• Controls and monitors a multi-position device (up to 8 positions), such as
rotary valves, and other devices with multiple fixed positions

• Monitors limit switches or other position feedback and displays actual
device position

• Checks for failure to reach the requested position within a configured
time. Provides Alarm on Position Failure

• Monitors Permissive conditions to allow moving to a new position

• Monitors Interlock conditions to de-energize the device, or to request the

device to return to Position 1. Provides an Interlock Trip Alarm if an
interlock condition causes the device to de-energize or return to Position 1

• Provides outputs to request each position, and provides outputs for
increasing and decreasing position

• Provides outputs to sequence indexing cylinders for devices that use
pneumatic or hydraulic devices to step through positions. The cylinders
work in an Extend, Shift, Retract, Shift sequence to engage the device, and
step it to the next position. The cylinder sequence reverses the Shift
directions when driving circular devices ‘counterclockwise’ (for devices
that support bidirectional operation)

• Optionally provides handling of a position lock or seal that must be driven
to an unlocked or unsealed state before moving the device, and returned to
a locked or sealed state after the move is completed

• If the optional lock or seal is used, provides position feedback for the lock
or seal to verify the locked or unlocked state at appropriate times. Provides
Alarm for Lock Failure

• Provides a simulation capability, responding as if a working device were
present while keeping outputs de-energized. The simulation capability can
be used for activities such as system testing, operator training, or as part of
a full process simulation

• Monitors for I/O communication faults and provides an I/O Fault Alarm

• Provides an ‘Available’ status for use by automation logic so the logic

knows when it has control of the device

• Provides maintenance capabilities, such as the ability to bypass any
bypassable interlocks or permissives or temporarily disable feedback
checking

10 Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017

n-Position Device (P_nPos)

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

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) P_nPos Graphics Library (RA-BAS-ME) P_nPos Graphics Library n-Position global object device symbols used to build

process graphics.

Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017 11

n-Position Device (P_nPos)

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

FactoryTalk View SE Software FactoryTalk View ME Software Description

(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 Misc Objects (RA-BAS-ME) Process Faceplate Misc Objects Miscellaneous global objects used on process object

(RA-BAS) Process Help Objects (RA-BAS-ME) Process Help Objects Global objects used for all process objects help displays.

(RA-BAS) Process Interlock Objects (RA-BAS-ME) Process Interlock Objects Global objects used for managing interlocks and

(RA-BAS) Process Mode Objects (RA-BAS-ME) Process Mode Objects Global objects used for managing modes on process

object faceplates.

faceplates.

faceplates.

permissives on process object faceplates.

object faceplates.

The Standard Display files (.gfx file type) in the following table are the Process
Library displays that you see at runtime.

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_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) P_nPos-Faceplate (RA-BAS-ME) P_n Pos-Faceplate The faceplate that is used for the object

(RA-BAS) P_nPos-Quick (RA-BAS-ME) P_nPos-Quick The Quick display that is used for the object

(RA-BAS) Process Discrete Family-Help (RA-BAS-ME) Process Discrete Family-Help The Help display for Discrete objects

(RA-BAS) P_Intlk-Faceplate (RA-BAS-ME) P_Intlk-Faceplate Optional

(RA-BAS) P_Perm-Faceplate (RA-BAS-ME) P_Perm-Faceplate Optional

(RA-BAS) Process Interlock Family-Help (RA-BAS-ME) Process Interlock Family-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 interlock faceplate used for the object.
Use this file if your Discrete Output has an associated

P_Intlk object and you enable navigation to its faceplate
from the Discrete Output faceplate.

Permissive faceplate that is used for the object
Use this file if your object has an associated P_Perm object

and you enable navigation to the P_Perm faceplate from
the object faceplate.

Interlock/permissives help display that is used for
the object

Use this file if you use the P_Intlk or P_Perm 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.

12 Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017

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.

n-Position Device (P_nPos)

Controller Code

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

n-Position Device 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_) are used by program logic to establish
runtime setpoints, thresholds, and so forth.

Table 6 - P_nPos Input Parameters

Input Parameter Data

Type

EnableIn BOOL 1 Ladder Diagram:

Inp_Pos1Fdbk BOOL 0 Position feedback. The parameter Cfg_HasPosFdbk determines if these parameters

Inp_Pos2Fdbk

Inp_Pos3Fdbk

Inp_Pos4Fdbk

Inp_Pos5Fdbk

Inp_Pos6Fdbk

Inp_Pos7Fdbk

Inp_Pos8Fdbk

Inp_LockFdbk BOOL 0 1 = Device confirmed Locked/Sealed In-Position.

Alias For Default Description

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.

are used.
1 = Device confirmed at position.

Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017 13

n-Position Device (P_nPos)

Table 6 - P_nPos Input Parameters

Input Parameter Data

Type

Inp_UnlockFdbk BOOL 0 1 = Device confirmed Unlocked/Unsealed and free to move.

Inp_CylExtFdbk BOOL 0 1 = Device indexing cylinder confirmed extended.

Inp_CylRetrFdbk BOOL 0 1 = Device indexing cylinder confirmed retracted.

Inp_CylLeftFdbk BOOL 0 1 = Device indexing cylinder confirmed in left position.

Inp_CylRightFdbk BOOL 0 1 = Device indexing cylinder confirmed in right position.

Inp_PermOK BOOL 1 1 = Permissives OK, device can energize.

Inp_NBPermOK BOOL 1 1 = Non-bypassable permissives OK, device can energize.

Inp_IntlkOK BOOL 1 1 = Interlocks OK, device can energize.

Inp_NBIntlkOK BOOL 1 1 = Non-bypassable Interlocks OK, device can energize.

Inp_IOFault BOOL 0 I/O communication status:

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

Inp_Hand BOOL Mode.Inp_Hand 0 1 = Select Hand (hard-wired) mode.

Inp_Ovrd BOOL Mode.Inp_Ovrd 0 1 = Select Override mode.

Inp_OvrdCmd SINT 0 Position command in Override mode:

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

Cfg_NumPos DINT 3 Number of device positions (2…8).

Cfg_Circ BOOL 0 Selects circular or linear for the device type:

Cfg_CWOnly BOOL 0 1 = Circular (rotary) device can rotate ‘clockwise’ only.

Cfg_ViaPos1 BOOL 0 1 = Drive linear device to Position 1 on every move.

Cfg_IntlkToPos1 BOOL 0 1 = Drive to Position 1 on interlock or fault.

Cfg_OutPosLatch BOOL 0 1 = Latch in Out_PosX until new position commanded.

Cfg_HasLock BOOL 0 1 = Must sequence a position lock or seal (sets Out_Unlock to move and Out_Lock

Cfg_HasPosFdbk BOOL 0 1 = Device has feedback for all positions.

Cfg_UsePosFdbk BOOL 0 1 = Position feedback shall be used to check device position.

Cfg_HasLockFdbk BOOL 0 1 = Device has locked/unlocked feedback.

Alias For Default Description

0 = OK
1 = Failure

keeping outputs de-energized. When set to 0, the instruction controls the device
normally.

0 = Stay
1 = Position 1
2 = Position 2
3 = Position 3
4 = Position 4
5 = Position 5
6 = Position 6
7 = Position 7
8 = Position 8

requiring reset are reset.

0 = Positions are linear
1 = Positions are circular (rotary device, the last position is adjacent to position 1)

0 = Bidirectional (use shortest path).

0 = Move direct to command position.

0 = De-energize only.

0 = De-energize Out_PoxX once target position is reached.

when move complete).

14 Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017

Table 6 - P_nPos Input Parameters

n-Position Device (P_nPos)

Input Parameter Data

Type

Cfg_UseLockFdbk BOOL 0 1 = Lock Feedback shall be used to verify locking and unlocking.

Cfg_HasCylFdbk BOOL 0 1 = Device indexing cylinders have position feedback.

Cfg_UseCylFdbk BOOL 0 1 = Indexing cylinder position feedback shall be checked.

Cfg_HasPermObj BOOL 0 1 = Tells HMI a permissive object (for example, P_Perm) is used for P_PermOK and

Cfg_HasIntlkObj BOOL 0 1 = Tells HMI an interlock object (for example, P_Intlk) is used for Inp_IntlkOK and

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_OCmdResets BOOL 0 1 = New Operator position command resets fault.

Cfg_CmdDuringMove BOOL 0 1 = New position command OK during move.

Cfg_OvrdPermIntlk BOOL 0 1 = Override ignores bypassable permissives/interlocks.

Cfg_ShedOnPosFail BOOL 0 1 = De-energize device and alarm on Position Fail.

Cfg_ShedOnLockFail BOOL 0 1 = De-energize device and alarm on Lock Fail.

Cfg_ShedOnIOFault BOOL 0 1 = De-energize device and alarm on I/O Fault.

Cfg_HasPosFailAlm BOOL PosFail.Cfg_Exists 0 These parameters determine whether the corresponding alarm exists and is

Cfg_HasLockFailAlm LockFail.Cfg_Exists

Cfg_HasIntlkTripAlm IntlkTrip.Cfg_Exists

Cfg_HasIOFaultAlm IOFault.Cfg_Exists

Cfg_PosFailResetReqd BOOL PosFail.Cfg_ResetReqd 0 These parameters determine whether a reset is required to clear the alarm status.

Cfg_LockFailResetReqd LockFail.Cfg_ResetReqd

Cfg_IntlkTripResetReqd IntlkTrip.Cfg_ResetReqd

Cfg_IOFaultResetReqd IOFault.Cfg_ResetReqd

Alias For Default Description

navigation to the permissive object’s faceplate is enabled.
IMPORTANT: The name of the Permissives object in the controller must be this

object's name with the suffix ‘_Perm’. For example, if your P_nPos object has the
name ’nPos123’, then its Permissives object must be named ‘nPos123_Perm’.

navigation to the interlock object’s faceplate is enabled.
IMPORTANT: The name of the interlock object in the controller must be this

object's name with the suffix '_Intlk'. For example, if your P_nPos object has the
name 'nPos123', then its interlock object must be named 'nPos123_Intlk'.

upon. When set to 0, program commands remain set until cleared by the
application program logic.

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.

0 = Reset required to clear fault.

0 = Must wait for previous command to finish.

0 = Always use permissives/interlocks.

0 = Alarm only.
IMPORTANT: When this option is 1 and a position fail condition occurs, a reset is

required before the device can be energized.

0 = Alarm only.
IMPORTANT: When this option is 1 and a lock fail condition occurs, a reset is

required before the device can be energized.

0 = Alarm only.
IMPORTANT: When this option is 1 and an I/O Fault condition occurs, a reset is

required before the device can be energized.

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 Hi.OCmd_Reset is required to clear
Alm_Hi alarm after the alarm is set and the value 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.

Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017 15

n-Position Device (P_nPos)

Table 6 - P_nPos Input Parameters

Input Parameter Data

Type

Cfg_PosFailAckReqd BOOL PosFail.Cfg_AckReqd 1 These parameters determine whether an acknowledgement is required for an

Cfg_LockFailAckReqd LockFail.Cfg_AckReqd

Cfg_IntlkTripAckReqd IntlkTrip.Cfg_AckReqd

Cfg_IOFaultAckReqd IOFault.Cfg_AckReqd

Cfg_PosFailSeverity INT PosFail.Cfg_Severity 1000 These parameters determine the severity of each alarm. This drives the color and

Cfg_LockFailSeverity LockFail.Cfg_Severity 1000

Cfg_IntlkTripSeverity IntlkTrip.Cfg_Severity 500

Cfg_IOFaultSeverity IOFault.Cfg_Severity 1000

Cfg_Retries SINT 0 Number of retries via Position 1 before declaring failure (0=don't retry).

Cfg_ExtendT REAL 0.0 Delay before extending cylinder to engage for move (seconds).

Cfg_VerifyT REAL 1.0 Delay to verify device has settled in commanded position (seconds).

Cfg_PosChkT DINT 30 Maximum time to reach target position before fail (seconds).

Cfg_LockChkT DINT 5 Maximum time to get locked /unlocked feedback before fail (seconds).

Cfg_PosSimT REAL 1.0 Time to reach target position in simulation (seconds).

Cfg_LockSimT REAL 1.0 Time to lock or unlock in simulation (seconds).

Cfg_CylSimT REAL 1.0 Time to simulate index cylinder feedback in simulation (seconds).

PSet_Owner DINT 0 Program owner request ID (non-zero) or release (zero).

PCmd_Pos1 BOOL 0 When Cfg_PCmdClear is 1:

PCmd_Pos2

PCmd_Pos3

PCmd_Pos4

PCmd_Pos5

PCmd_Pos6

PCmd_Pos7

PCmd_Pos8

PCmd_Acq BOOL Mode.PCmd_Acq 0 When Cfg_PCmdClear is 1:

PCmd_Rel Mode.PCmd_Rel

Alias For Default Description

alarm. When these parameters are 1, the acknowledge (ack) bit is cleared when
the alarm occurs. An acknowledge command (for example, PCmd_FailAck or
Fail.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.

symbol 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 severity drives the color and symbol that is used on the alarm banner
and alarm summary as well as the value returned by the FactoryTalk Alarms and
Events display commands.

• Set PCmd_Pos1 to 1 to go to Position 1

• Set PCmd_Pos2 to 1 to go to Position 2

• Set PCmd_Pos3 to 1 to go to Position 3

• Set PCmd_Pos4 to 1 to go to Position 4

• Set PCmd_Pos5 to 1 to go to Position 5

• Set PCmd_Pos6 to 1 to go to Position 6

• Set PCmd_Pos7 to 1 to go to Position 7

• Set PCmd_Pos8 to 1 to go to Position 8

• These parameters reset automatically

When Cfg_PCmdClear is 0:

• Set PCmd_Pos1 to 1 to go to Position 1

• Set PCmd_Pos2 to 1 to go to Position 2

• Set PCmd_Pos3 to 1 to go to Position 3

• Set PCmd_Pos4 to 1 to go to Position 4

• Set PCmd_Pos5 to 1 to go to Position 5

• Set PCmd_Pos6 to 1 to go to Position 6

• Set PCmd_Pos7 to 1 to go to Position 7

• Set PCmd_Pos8 to 1 to go to Position 8

• These parameters do not reset automatically

• Set PCmd_Acq to 1 to Acquire

• 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

16 Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017

Table 6 - P_nPos Input Parameters

n-Position Device (P_nPos)

Input Parameter Data

Type

PCmd_Lock BOOL Mode.PCmd_Lock 0 When Cfg_PCmdClear is 1:

PCmd_Unlock Mode.PCmd_Unlock

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

PCmd_PosFailAck BOOL PosFail.PCmd_Ack 0 • Set PCmd_<Alarm>Ack to 1 to Acknowledge alarm

PCmd_LockFailAck LockFail.PCmd_Ack

PCmd_IntlkTripAck IntlkTrip.PCmd_Ack

PCmd_IOFaultAck IOFault.PCmd_Ack

PCmd_PosFailSuppress BOOL PosFail.PCmd_Suppress 0 When Cfg_PCmdClear is 1:

PCmd_LockFailSuppress LockFail.PCmd_Suppress

PCmd_IntlkTripSuppress IntlkTrip.PCmd_Suppress

PCmd_IOFaultSuppress IOFault.PCmd_Suppress

PCmd_PosFailUnsuppress BOOL PosFail.PCmd_Unsuppress 0

PCmd_LockFailUnsuppress LockFail.PCmd_Unsuppress

PCmd_IntlkTripUnsuppress IntlkTrip.PCmd_Unsuppress

PCmd_IOFaultUnsuppress IOFault.PCmd_Unsuppress

PCmd_PosFailUnshelve BOOL PosFail.PCmd_Unshelve 0 • Set PCmd_<Alarm>Unshelve to 1 to Unshelve alarm

PCmd_LockFailUnshelve LockFail.PCmd_Unshelve

PCmd_IntlkTripUnshelve IntlkTrip.PCmd_Unshelve

PCmd_IOFaultUnshelve IOFault.PCmd_Unshelve

OCmd_Pos1 BOOL 0 Operator command to position.

OCmd_Pos2

OCmd_Pos3

OCmd_Pos4

OCmd_Pos5

OCmd_Pos6

OCmd_Pos7

OCmd_Pos8

OCmd_Bypass BOOL 0 Operator command to bypass all bypassable interlocks and permissives.

OCmd_Check BOOL 0 Operator command to check (not bypass) all interlocks and permissives.

MCmd_Disable BOOL Mode.MCmd_Acq 0 Maintenance command to disable device, enable (allow to energize), acquire

MCmd_Enable Mode.MCmd_Rel

MCmd_Acq Mode.OCmd_AcqLock

MCmd_Rel Mode.OCmd_UnlockRel

OCmd_AcqLock BOOL 0 Operator command to acquire (Program to Operator)/lock ownership.

Alias For Default Description

• Set PCmd_Lock to 1 to Lock

• 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

• This parameter is always reset automatically

• The parameter is reset automatically

• 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

• The parameter is reset automatically

ownership (Operator/Program/Override to Maintenance), or release ownership
(Maintenance to Operator/Program/Override).

Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017 17

n-Position Device (P_nPos)

Table 6 - P_nPos Input Parameters

Input Parameter Data

Type

OCmd_Unlock BOOL 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 reset and acknowledge all alarms and latched shed

Alias For Default Description

conditions.

n-Position Device 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. Status 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 set data entry fields.

Table 7 - P_nPos 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

18 Rockwell Automation Publication SYSLIB-RM031E-EN-P - February 2017

always reflects
EnableIn input state.