Professional Documents
Culture Documents
IMPORTANT
ATTENTION
Identifies information that is critical for successful application and understanding of the product.
Identifies information about practices or circumstances that can lead to personal injury or death,
property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and
recognize the consequence.
SHOCK HAZARD
Labels may be on or inside the equipment, for example, a drive or motor, to alert people that
dangerous voltage may be present.
BURN HAZARD
Labels may be on or inside the equipment, for example, a drive or motor, to alert people that
surfaces may reach dangerous temperatures.
Allen-Bradley, Rockwell Automation, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation, Plant PAx Process Automation System, and TechConnect are property of their respective companies.
Summary of Changes
Introduction
This release of this document is updated throughout for version 2.0 of the
Logix CPU Utilization (L_CPU) Add-On Instruction and Graphics. Please
refer to the Release Notes that are distributed with version 2.0 of the Library.
Updated Information
Change:
See:
All
iii
Summary of Changes
Notes:
iv
Table of Contents
Preface
Chapter 1
Overview
Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Primary Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Revision Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Chapter 2
Configuration Options
Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Chapter 3
Instruction Data Reference
L_CPU_Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configurations (Cfg_). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operator Commands, Maintenance Commands, Command Readies
(OCmd, MCmd_, Rdy_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operator Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maintenance Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Status (Sts_) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Device Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
17
18
19
19
19
21
21
Table of Contents
Chapter 4
HMI Reference
vi
Graphic Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Faceplate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operator Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Communications Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CPU Usage Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Memory Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connections Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maintenance Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logix CPU Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
24
25
25
27
28
29
30
31
33
Preface
This term:
Means:
Set
Clear
vii
Preface
Level
IMPORTANT
viii
Preface
IMPORTANT
ix
Preface
Pre-Scan
During the transition into RUN, the controller performs a Pre-scan before the
first logic scan. Pre-scan is a special scan of all routines in the controller. The
controller scans all main routines and subroutines during Pre-scan, but ignores
jumps that could skip the execution of instructions. The controller executes all
FOR loops and subroutine calls. If a subroutine is called more than once, it is
executed each time it is called. The controller uses Pre-scan instructions to
reset non-retentive data values.
During Pre-scan, input values are not current and outputs are not written. The
following conditions generate Pre-scan:
toggle from Program to Run mode.
automatically enter Run mode from a power-up condition.
Pre-scan does not occur for a program when:
the program becomes scheduled while the controller is running.
the program is unscheduled when the controller enters Run mode.
IMPORTANT
Preface
Description:
Pre-scan
xi
Preface
EXAMPLE
If the user modifies the data in the Input Field and moves to a different field without
pressing the Enter key, the border remains a solid line indicating that the data has not
been saved to the tag.
EXAMPLE
If the data in the Input Field has not changed or has been written to the controller
tag, the border is a dashed line.
EXAMPLE
xii
Chapter
Overview
Chapter 1
Overview
Functional Description
The L_CPU instruction collects and summarizes a variety of data from the
Logix controller it is monitoring, including:
Processor Identity information
Catalog Number and Description
Major and Minor firmware revision numbers
Communication Responsiveness information
CPU% available for responding to communications requests
CPU% used for responding to communications requests
Optimized Packets used for responding to communications requests
Memory Usage (total and for each of several classes of memory)
Total memory size
Memory used
Memory available
Largest contiguous block of available memory
Scan Times (for a selected Task)
Maximum scan time
Most recent scan time
CPU Utilization (%) for:
The Continuous Task (or unused CPU, if no Continuous Task)
Periodic and Event Tasks
Motion/Synchronization
Safety Tasks
Redundancy
Sending Messages (MSG)
Responding to communications requests (such as from HMI)
System (I/O scan, timer updates, everything else)
Communication Connection usage:
Total connections available
Connections used for each of several classes of communication
Unconnected Buffers and Cached Messages
I/O Forcing status
Controller Minor Faults
Communication Timeslice setting
Overview
Chapter 1
Primary Operations
The L_CPU Instruction logic is firmware version dependent. There are different
versions of the instruction for each major release (18.x, 19.x, etc.) of Logix
firmware. Be sure to load the right version.
The L_CPU Instruction does not support SoftLogix controllers or the
emulated controller in RSLogix Emulate 5000. If the L_CPU Instruction
identifies the controller as the wrong firmware version or as an unsupported
controller, it will not poll, but rather will assert the Sts_WrongVersion status
flag.
IMPORTANT
The L_CPU Instruction must be configured with the slot number of the controller.
If the Instruction is asserting the Sts_MsgErr flag, that means it cannot
communicate via MSG to the controller. Check the Cfg_SlotNumber
configuration. If you change Cfg_SlotNumber, it may be necessary to cycle the
controller mode to Program, then back to Run, for the change to take effect.
Chapter 1
Overview
TIP
You can find the correct slot number using RSLogix 5000 software. In the
Controller Organizer, select the controller (top item). Right-click and select
Properties. The controller slot number is shown near the bottom of the properties
window. For controllers where the slot number is not configurable, this item will
be disabled (grayed out); regardless, it still displays the correct number to use to
configure the L_CPU Instruction.
Overview
Chapter 1
Operating Modes
Alarms
The L_CPU Instruction does not generate any alarms. If an alarm is needed
when a specific metric crosses a threshold, you will need to add logic to do the
checking. The logic can be as simple as a comparison (CMP, GRT, GEQ, LES,
LEQ or LIM instruction) plus a P_Alarm Add-On Instruction.
Refer to the Process Add-On Instructions and Graphics: Alarm (P_Alarm)
Reference Manual, publication SYSLIB-RM002, for more information.
Execution
Description
Chapter 1
Overview
Revision Compatibility
The L_CPU Add-On Instruction in RSLogix 5000 software and the Faceplate
in FactoryTalk View software are marked with revision information as shown
in the following table:.
Component
Example
The Instruction and Faceplate are compatible if they have the same Major and
Minor Revision numbers.
The Major Revision is the first number, before the period.
The Minor Revision is the second number, after the period and before the
hyphen or space.
Information after the hyphen or space indicates the Tweak Revision. The
Instruction and Faceplate do not have to have the same Tweak Revision to be
compatible.
In the table above, the Add-On Instruction and Faceplate shown are
compatible because they have the same Major.Minor (1.1).
Chapter
Configuration Options
Configuration Parameters
Enter the appropriate values from the following table into the L_CPU
Instructions configuration parameters to configure it for your application.
Use the HMI Faceplate or the RSLogix 5000 Tag Monitor function to set the
applicable configuration parameter(s).
TIP
To install the L_CPU instruction, import the entire L_CPU Ladder Diagram rung
(not just the instruction). When you import the rung, all the User-Defined Data
Types, Tags and their values required by the instruction are imported as well,
including MSG configurations, data required to be sent by the Messages, and
default instruction configuration, Your application will have the Controller Tag
L_CPU_Out created and placed in the L_CPU instruction's Ref_Out InOut
Parameter. In the Associated Parameters column below, references to
L_CPU_Out mean the Tag referenced in the Ref_Out InOut Parameter.
Parameter:
Default:
Cfg_MainTaskInstance 1
None
Associated Parameters:
L_CPU_Out.ScanTimes.ScanTimeMax
L_CPU_Out.ScanTimes.ScanTimeLast
Chapter 2
Configuration Options
Parameter:
Default:
Cfg_SlotNumber
None
(Obtain this
value from
RSLogix 5000
software, then
code a MOV to
move it to this
parameter in
logic.)
TIP
Associated Parameters:
If this parameter is set incorrectly, the
Message (MSG) instructions
contained in the L_CPU instruction
will error. This is reflected in the
Sts_MsgErr status bit of the L_CPU
instruction.
Cfg_SupportInfo
Enter
Software
S/N or
Support
Contract
Number
Maintenance
None
Configuration Options
Parameter:
Default:
Cfg_UpdateT
5 sec
Maintenance
Chapter 2
Associated Parameters:
Sts_Timing
All metrics in L_CPU_Out will be updated
at this interval.
1.0 sec
None
IMPORTANT
Setting this parameter too low may
result in CPU usage data that are
imprecise, or not meaningful
averages, because they are collected
over too short a time to see all tasks
the controller is performing. Setting
this parameter too high may result in
averaged CPU usage data that may not
capture bursts in certain activities. It is
recommended you keep this
parameter at its default value unless
instructed to change it by Rockwell
Automation Technical Support.
L_CPU_Out.CPUUse.Motion
L_CPU_Out.CPUUse.Redundancy
L_CPU_Out.CPUUse.Safety
L_CPU_Out.CPUUse.System
L_CPU_Out.CPUUse.PeriodicAndEvent
L_CPU_Out.CPUUse.ContinuousOrFree
Chapter 2
Configuration Options
Notes:
10
Chapter
L_CPU_Out
Name:
Substructure:
This section shows the L_CPU Instructions Ref_Out (reference output) tags
data structure. This structure is contained in the L_CPU_Out User-Defined
Data Type (UDT). This UDT is imported if you import the entire L_CPU
rung rather than just the Add-On Instruction.
Type:
Element:
Style:
L_CPU_Out
Description:
Associated Parameter:
Device Identity
SINT[33]
Name
ASCII
INT
VendorID
INT
ProductType
INT
ProductCode
SINT
Major
SINT
Minor
DINT
Serial
Hex
INT
Status
Binary
11
Chapter 3
Name:
Substructure:
Type:
Element:
Style:
CommUse
12
Description:
Associated Parameter:
Communication usage
REAL
RespCPUAvail
Float
REAL
RespCPUAct
Float
DINT
MaxTrendInstance
DINT
NumTrendInstances
DINT
TrendHighWater
Name:
Substructure:
Type:
Element:
Style:
MemUse
Description:
Chapter 3
Associated Parameter:
Memory usage
DINT
FreeIO
DINT
FreeDataLogic
DINT
FreeGen
DINT
FreeSafety
DINT
TotalIO
DINT
TotalDataLogic
DINT
TotalGen
DINT
TotalSafety
DINT
MinIO
DINT
MinDataLogic
DINT
MinGen
DINT
MinSafety
DINT
MaxBlockIO
DINT
DINT
MaxBlockGen
DINT
MaxBlockSafety
ScanTimes
Scan Times
REAL
ScanTimeMax
Float
REAL
ScanTimeLast
Float
13
Chapter 3
Name:
Substructure:
Type:
Element:
Style:
CPUUse
14
Description:
Associated Parameter:
CPU usage
REAL
Comms
Float
Communications
(responding to HMI and
MSGs) %CPU
REAL
Messaging
Float
REAL
Motion
Float
REAL
Redundancy
Float
Redundancy
Communication and
Synchronization %CPU
REAL
Safety
Float
REAL
System
Float
REAL
PeriodicAndEvent
Float
REAL
ContinuousOrFree
Float
Name:
Substructure:
Type:
Element:
ConnUse
Style:
Description:
Chapter 3
Associated Parameter:
Connection usage
INT
TotalAllow
INT
TotalCurr
INT
TotalHiWater
INT
IOAllow
INT
IOCurr
INT
IOHiWater
INT
ProdAllow
INT
ProdCurr
INT
ProdHiWater
INT
ConsAllow
INT
ConsCurr
INT
ConsHiWater
INT
MSGCurr
INT
MSGHiWater
INT
IncomCurr
INT
IncomHiWater
DINT
UCBsAllow
DINT
UCBsCurr
DINT
UCBsHiWater
15
Chapter 3
Name:
16
Substructure:
Type:
Element:
Style:
Description:
INT
MCacheAllow
INT
MCacheCurr
INT
MCacheHiWater
TimeSlice
INT
IOLEDStatus
INT
ForceStatus
INT
MinorFaultCount
DINT
MinorFaultProg
BOOL
MinorFaultTask
BOOL
MinorFaultPort
BOOL
MinorFaultBatt
BOOL
Associated Parameter:
Execution
Chapter 3
Execution parameters are included with every Add-On Instruction. See the
Logix5000 Controllers Add-On Instructions Programming Manual,
publication 1756-PM010, for more information on these data elements.
Name:
Data Type:
Usage:
Default:
EnableIn
BOOL
Input
Enable Input:
1 = Normal Scan: monitor Logix CPU
utilization
0 = No action (no EnableInFalse logic is
provided)
EnableOut
BOOL
Output
Inf_Tab
SINT
Inf_Type
STRING_16
L_CPU
L_CPU
BOOL
Output
Style: Description:
Associated
Configuration
Parameter
17
Chapter 3
Configurations
(Cfg_)
Name:
Data Type:
Associated
Configuration
Parameter
Usage:
Default:
Style:
Description:
Cfg_MainTaskInstance DINT
Input
Decimal
Cfg_SlotNumber
DINT
Input
Decimal
Cfg_UpdateT
DINT
Input
5 sec
Decimal
Cfg_WindowT
REAL
Input
1.0 sec
Float
Because they use arrayed or structured data types, the following Configuration
data elements use L_CPU Add-On Instruction Local Tags. These may be
modified using RSLogix 5000 software or using the HMI Faceplates, but
cannot be modified using controller logic.
Name:
Data Type:
Cfg_Desc
STRING_40
Cfg_Label
STRING_20
'CPU
STRING
Utilization'
Cfg_SupportInfo
STRING_40
Cfg_Tag
STRING_20
18
Usage:
Local
Default:
Style:
Associated
Configuration
Parameter
Description:
Enter
Software
S/N or
Support
Contract
#
ASCII
'L_CPU'
STRING
Operator Commands,
Maintenance Commands,
Command Readies
(OCmd, MCmd_, Rdy_)
Chapter 3
Operator Commands
Name:
Data Type:
Usage:
Default:
Style: Description:
OCmd_Enable
BOOL
Input
Edge
OCmd_Disable
BOOL
Input
Edge
Associated
Configuration
Parameter
Maintenance Commands
Name:
Data Type:
Usage:
Default:
Style: Description:
MCmd_Enable
BOOL
Input
Edge
MCmd_Disable
BOOL
Input
Edge
Associated
Configuration
Parameter
19
Chapter 3
Name:
Data Type:
Usage:
Default:
Rdy_Enable
BOOL
Output
Rdy_Disable
BOOL
Output
20
Style: Description:
Status
(Sts_)
Chapter 3
Status data elements contain device status. The HMI displays these Status
points, and they are available for use by other application logic.
Device Status
Style: Description:
Associated
Configuration
Parameter
Name:
Data Type:
Usage:
Default:
Sts_Enabled
BOOL
Output
Sts_Timing
BOOL
Output
Sts_Busy
BOOL
Output
Sts_Done
BOOL
Output
Sts_MsgErr
BOOL
Output
Sts_WrongVersion
BOOL
Output
Sts_Timing
BOOL
Output
Cfg_UpdateT
Sts_MsgErr
BOOL
Output
Cfg_SlotNumber
Sts_WrongVersion
BOOL
Output
21
Chapter 3
Notes:
22
Chapter
HMI Reference
This chapter describes the HMI Graphic Symbols and Faceplate provided for
human-machine interface (HMI) for the L_CPU Instruction.
Graphic Symbols
Graphic Symbols are provided for use on end-user process graphic displays.
L_CPU Graphic Symbols have the following common attributes:
L_CPU Graphic Symbol
Status Indicators
Touch Field to
recall Faceplate
The L_CPU Graphic Symbol looks like a physical controller and is intended to
be used in a chassis view or network view display with symbols for other
modules including I/O, communication cards and others. The L_CPU
Graphic Symbol has indicators that match the status on the face of the actual
controller and use the same colors and blink states.
The L_CPU Graphic Symbol includes a touch field; clicking the Symbol will
call up the L_CPU Faceplate. Hovering the pointing device pointer over the
Symbol will display its tooltip, giving the Controller name and
communication path.
23
Chapter 4
HMI Reference
Graphic Representation
The Status Indicators on the Graphic Symbol change color and blink state
depending on the controller status.
Indicator
State
24
HMI Reference
Faceplate
Chapter 4
Operator
Memory
CPU Usage
Maintenace
Connections
Exit
Help
Operator Tab
Controller Mode
Controller Status
Controller Catalog
Number
Controller Clock
Date and Time
Minor Fault Count
Status of HMI
Communication with
Controller
I/O Communication and I/O
Forcing Status Indicators
Redundant Controller
Status
Controller firmware version
(Major. Minor)
Controllers configured
Communication Timeslice
Communication Bar graph
Data Values
25
Chapter 4
HMI Reference
Controller Mode
Controller Status
Status of HMI Communication with the Controller
I/O Communication and I/O forcing status indicators
The Controllers redundancy status (only displayed for a Controller in a
redundant configuration)
Controller identity information, including catalog number and firmware
major and minor revision
Count of Minor Fault occurrences, and indicators for currently active
Minor Faults of specific classes
The Controllers configured Communication Timeslice value
A nested bar graph and numeric displays showing the approximate
percent CPU available for responding to communications requests (such
as from HMI) (outer bar), and the approximate percent CPU actually
being used for responding to communications requests (inner bar). The
outer bar graph changes color from green to yellow when CPU available
for communications is low, and the inner bar graph changes color from
blue to red when nearly all CPU available for communications is being
used.
Count of RSLinx Optimized Packets currently used, the high-water
value of Optimized Packets used, and the largest Optimized Packet
Instance Number used in the controller.
TIP
The Operator (Home) Tab displays the information most commonly requested by
Rockwell Automation Technical Support when you place a call for support for a Logix
controller. You will also need your software serial number or technical support
contract number. A space is provided for you to record this information on the
Maintenance Tab for ready reference when you call. The Technical Support
Specialist may or may not require information from the other tabs depending on the
nature of the issue.
26
HMI Reference
Chapter 4
Communications Tab
27
Chapter 4
HMI Reference
The CPU Usage tab displays the approximate CPU percentage used by each
of the controllers major activities. If there is a Continuous Task running in the
controller, the top segment of the bar graph shows the CPU used by the
Continuous Task. If there is no Continuous Task, the top segment shows the
percentage CPU free (unused).
Note: The usage values may not sum to 100%.
The Main Task Scan Times are for the Task whose instance number is passed
into the L_CPU instruction. This instance number is obtained using a GSV
(built-in) Instruction on the rung which executes the L_CPU Instruction. This
GSV is included if you installed the L_CPU instruction using a Rung Import.
Just enter the name of the controller Task you want to monitor into the GSV
Instruction. (The Task name in the GSV can be changed by online editing.)
28
HMI Reference
Chapter 4
Memory Tab
Note: Only those memory sections that exist (have non-zero size) are shown
in the graphic above. Each section (I/O Memory, Data and Logic Memory,
General Memory, and Safety Memory) is visible only if the controller returns a
size for it that is non-zero.
The Memory tab displays the size of overall controller memory and the
amount free. For each memory section displayed, the Memory Tab shows:
29
Chapter 4
HMI Reference
Connections Tab
Controller
Connection Statistics
30
HMI Reference
Chapter 4
Maintenance Tab
Other Configuration
data (display only)
31
Chapter 4
HMI Reference
Action
Security
Required
Code C
IMPORTANT
The L_CPU Instruction
accomplishes its data collection
using Message (MSG) instructions
to the controller (MSG to self),
which uses some controller
communication resources. You
may wish to leave data collection
disabled until it is needed. Some
Faceplate data are monitored
without using the polling
messages and will still be
displayed.
Click to disable collection of
controller data.
Code C
Code C
IMPORTANT
Setting this parameter too low will
result in a flood of Messages
(MSG) to the controller, possibly
impacting control performance. Do
not use a value less than 5
seconds unless instructed to do so
by a Rockwell Automation
Technical Support specialist.
Support Information (Serial # or
Contract #)
32
Code E or P
HMI Reference
Chapter 4
33
Chapter 4
HMI Reference
Notes:
34
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
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.
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 erenky, stanbul, Tel: +90 (216) 5698400