Rockwell Automation Library of Process Objects: Hand-Operated Motor (P - Motorho)
Rockwell Automation Library of Process Objects: Hand-Operated Motor (P - Motorho)
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.
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
IPreface Software Compatibility and Content Revisions . . . . . . . . . . . . . . . . . . . 5
Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Hand-operated Motor Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
(P_MotorHO) Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Hand-operated Motor Input Structure . . . . . . . . . . . . . . . . . . . . . . 11
Hand-operated Motor Output Structure . . . . . . . . . . . . . . . . . . . . 14
Hand-operated Motor Local Configuration Tags. . . . . . . . . . . . . 17
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Display Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
State Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Using Display Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Quick Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Hand-operated Motor Faceplate Help. . . . . . . . . . . . . . . . . . . . . . . 41
Notes:
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.
Additional Resources These documents contain additional information concerning related products
from Rockwell Automation.
Resource Description
PlantPAx® Distributed Control System Selection Guide, Provides information to assist with equipment
publication PROCES-SG001 procurement for your PlantPAx system.
PlantPAx Distributed Control System Reference Manual, Provides characterized recommendations for
publication PROCES-RM001 implementing your PlantPAx system.
Rockwell Automation Library of Process Objects, Provides general considerations for the PlantPAx system
publication PROCES-RM002 library of process objects.
FactoryTalk® View Machine Edition User Manual, Provides details on how to use this software package for
publication VIEWME-UM004 creating an automation application.
FactoryTalk View Site Edition User Manual, Provides details on how to use this software package for
publication VIEWSE-UM006 developing and running human-machine interface (HMI)
applications that can involve multiple users and servers,
distributed over a network.
Logix5000™ Controllers Add-On Instructions Provides information for designing, configuring, and
Programming Manual, publication 1756-PM010 programming Add-On Instructions.
Rockwell Automation Library of Process Objects: Common Details how to monitor an input condition to raise an
Alarm Block (P_Alarm) Reference Manual, alarm. Information includes acknowledging, resetting,
publication SYSLIB-RM002 inhibiting, and disabling an alarm. Generally the P_Alarm
faceplate is accessible from the Alarms tab.
Rockwell Automation Library of Process Objects: Explains how to collect (sum up) the interlock conditions
Interlocks with First Out and Bypass (P_Intlk) Reference that stop or de-energize a running or energized piece of
Manual, publication SYSLIB-RM004 equipment or prevent it from starting or being energized.
Rockwell Automation Library of Process Objects: Run Time Explains how to accumulate the total run time and count
and Starts (P_RunTime) Reference Manual, of starts for a motor or other equipment
publication SYSLIB-RM010
Rockwell Automation Library of Process Objects: E1 Plus™ Details how to control and monitor a 193-ETN (E1 Plus on
Overload Relay (P_E1PlusE) Reference Manual, EtherNet/IP) overload relay.
publication SYSLIB-RM049A-EN-P
Rockwell Automation Library of Process Objects: Details how to ccontrol and monitor a 193/592-EC1, -EC2,
E3™/E3 Plus™ Overload Relay (EtherNet/IP) (P_E3Ovld) -EC3, or -EC5 (E3 or E3 Plus) overload relay.
Reference Manual, publication SYSLIB-RM050A-EN-P
Rockwell Automation Library of Process Objects: E300™ Details how to controls and monitors a 193-ECM-ETR
Overload Relay (EtherNet/IP) (P_E300Ovld) Reference (E300 on EtherNet/IP) overload relay.
Manual, publication SYSLIB-RM051A-EN-P
Faceplate
Global Objects
Add-On Instruction
This instruction supports an optional trip function and output, used to stop the
motor. If the trip output is used, this instruction confirms that the motor stops if
tripped, and alarms if it does not stop.
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_MotorHO_3_5-00_AOI.L5X Add-On Instruction must be imported
into the controller project 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_MotorHO Graphics Library (RA-BAS-ME) P_MotorHO Graphics Library P_MotorHO global object device symbols used to build
process graphics.
(RA-BAS) Process Alarm Objects (RA-BAS-ME) Process Alarm Objects Global objects used for managing alarms on process
object faceplates.
(RA-BAS) Process Diagnostic Objects (RA-BAS-ME) Process Diagnostic Objects Diagnostic global objects used on process object
faceplates.
(RA-BAS) Process Faceplate Motor Objects (RA-BAS-ME) Process Faceplate Motor Objects Motor global objects used on process object faceplates.
(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
permissives on process object faceplates.
The Standard Display files (.gfx file type) in the following table are the Process
Library displays that you see at runtime.
Controller Code This section describes the parameter references for this Add-On Instruction.
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 application export/import
functionality.
Table 8 - Local Configuration Tags
Tag Name Data Type Default Description
Cfg_Desc STRING_40 'Hand-operated Description for display on HMI. This string is shown in the title bar of the faceplate.
Motor'
Cfg_FastFwdText STRING_16 'Running' Text for Running, Fast or Forward for display on HMI.
Cfg_Label STRING_20 'Motor Monitor' Label for graphic symbol displayed on HMI. This string appears on the graphic symbol.
Cfg_SlowRevText STRING_16 'Slow' Text for Slow or Reverse for display on HMI.
Cfg_Tag STRING_20 'P_MotorHO' Tagname for display on HMI. This string is shown in the title bar of the faceplate.
Operations This section describes the primary operations for Add-On Instructions.
Modes
The P_MotorHO instruction does not have modes and does not use an
embedded P_Mode Add-On Instruction. The P_MotorHO instruction is used
to monitor a locally operated motor. If the optional trip function is used, the
operator, program, or interlock logic can trip the motor at any time.
Alarms
This instruction uses the following alarms, which are implemented by using
embedded P_Alarm and P_Gate Add-On Instructions.
The trip fail alarm has a configurable delay to allow the run feedback time to
show that the motor actually stopped (when tripped) before raising an alarm.
Simulation
Simulation in P_MotorHO disables the normal input and lets you select a
simulated input to see the reaction of the Hand-operated Motor.
You must set the Inp_Sim parameter in the controller to ‘1’ to enable simulation.
You can set the following parameters to simulate the corresponding input and
feedback time to the Hand-operated Motor:
• Inp_SimRunFastfwd - sets the simulated motor to run fast or forward
• Inp_SimSlowRev - sets the simulated motor to run slow or in reverse
• Inp_SimStopped - sets the simulated motor to stop
• CfgSimFdbkT - sets the number of seconds to delay echoing back the
running or stopped status in simulation
When you have finished in simulation, set the Inp_Sim parameter in the
controller to ‘0’ to return to normal operation.
Execution
Condition Description
EnableIn false (false rung) Handled the same as if the trip function option were
disabled. The trip output (Out_Trip) is de-energized. The
instruction reverts to monitoring only the current state of
the motor. All alarms are cleared.
Powerup (pre-scan, first scan) Any commands received before first scan are discarded.
The Trip output is de-energized to prevent a nuisance trip
on first scan.
Embedded P_Alarm instructions are handled in
accordance with their standard powerup procedures.
Refer to the reference manual for the P_Alarm
instructions for more information.
Postscan (SFC transition) No SFC postscan logic is provided.
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.
The P_MotorHO instruction has graphic symbols for motors, blowers, agitators,
and pumps for use on process graphic displays.
Status/Quality Indicator
Current State
Device Symbol Indicator
The P_MotorHO graphic symbol displays the current state of the motor.
Each graphic symbol includes a touch field over it that opens the instruction
object’s faceplate. In addition there is a tooltip on the graphic symbol that
displays the object’s configured tag and description.
State Indicators
The state indicator text changes and the graphic symbol color changes depending
on the state of the motor.
Status/Quality Indicators
One of these symbols appears on the graphic symbol when the described
condition is true.
Graphic Symbol Description
Invalid configuration.
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 appear in a magenta box.
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.
For the Hand-operated Motor instruction, the Device Not Ready indicator
appears under the following conditions:
• Device has been disabled by Maintenance.
• There is a configuration error.
• Interlock is not OK.
• Device has tripped at the device or by command.
• Device Failure and shed requires reset.
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.
No symbol No change in color No alarm or alarm inhibit condition, and all alarms
are acknowledged.
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 then bypass. Once you
navigate to the tab, the bypassed item is flagged with this indicator.
The graphic symbol for P_MotorHO instruction can be found in the global
object file (RA-BAS) P_MotorHO 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
Parameter Values.
3. Type the tag or value in the Value column as specified in the Description
column.
4. Click OK.
Quick Display The Quick Display screen provides the means for operators to perform simple
interactions with the P_MotorHO 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 P_MotorHO faceplate consists of five tabs and each tab consists of one or
more pages.
The title bar of the 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 Diagnostics Exit
Operator Tab
The Faceplate initially opens to the Operator (‘Home’) tab. From here, an
operator can monitor the device status.
Reset and
Acknowledge All
Alarms Command
Button
The Operator tab also has buttons to open the runtime and Overload faceplates
if the motor is configured to have associated runtime or Overload objects (for
example, Cfg_HasRunTimeObj = 1). When the object is not configured to have
an associated runtime or Overload object, the runtime and/or Overload buttons
are not displayed.
Non-bypassed conditions OK
All conditions OK
The following table shows the alarm status symbols that are used on the Operator
tab.
Table 13 - Operator Tab Alarm Status
Graphic Symbol Alarm Status
In Alarm (Active Alarm)
Alarm indicators appear on the Operator tab when the corresponding alarm
occurs.
Maintenance Tab
Maintenance personnel use the information and controls on the Maintenance tab
to adjust device parameters, troubleshoot and temporarily work around device
problems, and disable the device for routine maintenance.
Time after 'Trip' for Enter the amount of time to allow motor run Cfg_TripFailT
feedback before feedback to show that the motor stopped after
Fault (seconds) a trip is commanded. If the motor does not
show stopped in the allowed time, a Trip Fail
alarm is raised.
Engineering Tab
The following table shows the functions on page 1 of the Engineering tab.
The following table shows the functions on page 2 of the Engineering tab.
Diagnostics Tab
The Diagnostics tab displays possible reasons the device is not ready.
The preceding image indicates the device is not ready due to a device failure and
that shed requires a reset before a restart can be performed.
Alarms Tab
The Alarms tab displays each configured alarm for the P_MotorHO instruction.
The icon on the tab for the alarms page changes color based on the current active
alarms. A blinking alarm icon indicates that one or more alarms must be
acknowledged or the device must be reset.
Alarm Acknowledge
Command Button
Alarm Names
Alarm Severity
Indicators
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.
Color Definition
Magenta Urgent
Red High
Yellow Medium
Blue Low
White (bell icon) Alarm has cleared but is unacknowledged
Background (Light Gray) No alarm
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.
Notes:
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.
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
distributor to complete the return process.
Outside United States Please contact your local Rockwell Automation representative for the return procedure.
Documentation Feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this
document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.
Rockwell Otomasyon Ticaret A.Ş., Kar Plaza İş Merkezi E Blok Kat:6 34752 İçerenköy, İstanbul, Tel: +90 (216) 5698400