syslib-rm042 - Literature Library
Contents
1. e Oo Rockwell Automation Publication SYSLIB RM042B EN P August 2014 11 Analog Input Channel P_AlChan Table 3 P_AlChan Input Parameters Input Parameter Data Description Type Cfg_InpOORAction SINT 1 PV action on Out of range stuck unchanging PV not a number 1 0 module fault 1 0 channel fault Inp_PVUncertain function check maintenance required Cfg_InpStuckAction or AOI configuration error Cfg_InpNaNAction 1 Pass input PV through unchanged 2 Hold last good PV value Cfg_ModFaultAction 3 Replace PV value with Cfg_PVReplaceVal Cfg_ChanFaultAction Cfg_OutOfSpecAction Cfg_FuncCheckAction 3 Cfg_MaintRegdAction Cfg_CfgErrAction Cfg_InpOORQual SINT PV quality to report for Out of range stuck unchanging PV not a number 1 0 module fault 1 0 channel fault Inp_PVUncertain function check maintenance Cfg_InpStuckQual required or AOI configuration error Cfg_InpNaNQual 3 1 Good 2 Uncertain Cfg_ModFaultQual 3 Bad Cfg_ChanFaultQual Cfg_OutOfSpecQual Cfg_FuncCheckQual 3 Cfg_MaintReqdQual Cfg_CfgErrQual Cfg_StuckT DINT Pf Time with no change in input to raise stuck status s Cfg_PVReplaceVal REAL AIN Value engineering units to use to replace PV when action replace PCmd_FailAck BOOL Fail PCmd_ Ack e Set PCmd_ lt Alarm gt Ack to 1 to Acknowledge alarm e The parameter is reset automatically PCmd_FailSuppress Fail PCmd Fail PCmd_Suppress When Cfg_PCmdClearis 1 e Set PCmd_ lt Alarm gt Suppress to 12. Condition Description Enableln False false rung Clear any received commands Reset internal timers Clear the Fail alarm Flag input quality as bad Show alarm inhibited status as disabled Other parameters are left in their last state Powerup prescan first scan Reset internal timers Clear any received commands Postscan SFC Transition No SFC postscan logic is provided Refer to the Logix5000 Controllers Add On Instructions Programming Manual publication 1756 PM010 for more information The following example provides shows the connection from raw analog input through process value by using the P_AIChan block The raw input value Local 1 I ChOData from the analog input card is used as the raw input value Inp_Raw for the P_AIChan block The output value Val and quality SrcQ from the P_AIChan block are used as inputs for the P_AIn block In this configuration the P_AIn block uses the Cfg_HasChanObj configuration parameter The final output process value Feedwater_Flow is the fully converted scaled and filtered analog value that is propagated through the system The P_AIChan block also uses the Channel Fault and Module Fault parameters taken from the same analog input module as the process value Inp_ChanFault is simply the tag value for the channel Local 1 1 Ch0Fault The Inp_ModFault parameter Rack1Slot4ModFault is generated by using a GSV to the module object with the instance for the appropriate card
3. Graphic Symbol 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 MES lt Rockwell Automation Publication SYSLIB RM042B EN P August 2014 23 Analog Input Channel P_AlChan Maintenance Tab Maintenance personnel use the information and controls on the Maintenance tab to make adjustments to device parameters FT101_Chan Analog Channel Quality i z so oe A Maintenance Value 50 to use to replace PW when Action Replace one Minimum time In Range to clear Out O of Range status sec Minimum time Out of Range to raise O status sec Time with no change in Input to raise an stuck Status sec Threshold Deadband m DC mA DC 20 73 Input Out of Range Fail 0 07 3 67 PY Clamping Limits Lowy 1 50E38 High 1 50E35 The following table shows the functions on the Maintenance tab Table 12 Maintenance Tab Descriptions Function Action Security Configuration Parameters Value EU to useto Type the value to output as the PV Configuration Cfg_PVReplaceVal replace PV when when a condition occurs that has its amp Tuning Action Replace action set to Replace Maintenance __ i Code D Minimum time In Type the amount of time the input Cfg_InpOOROffDly Range to clear Out must stay within the range thresholds of Range Status with dead
4. or Replace PV Input not a Number Quality Good Quality Uncertain or Bad Quality Input out of Range Action Use Input Hold Input or Replace PV Input out of Range Quality Good Quality Uncertain or Bad Quality Function Check Action Use Input Hold Input or Replace PV Function Check Quality Good Quality Uncertain or Bad Quality Input Stuck Action Use Input Hold Input or Replace PV When there is a channel fault Set Sts_PVGood e Set Sts_ PVUncertain Set Sts_ PVBad Engineering Configuration Code E When there is a module fault e Use the input to determine value e Hold value at its last good value e Set value by using Cfg_PVReplaceVal When there is a module fault e Set Sts_PVGood e Set Sts_ PVUncertain Set Sts_PVBad When the input is not a number e Use the input to determine value e Hold value at its last good value Set value by using Cfg_PVReplaceVal When the input is not a number Set Sts_PVGood e Set Sts_ PVUncertain Set Sts_ PVBad When the input is out of range e Use the input to determine value e Hold value at its last good value e Set value by using Cfg_PVReplaceVal When the input is out of range Set Sts_PVGood e Set Sts_ PVUncertain Set Sts_ PVBad When Inp_FuncCheck is set e Use the input to determine value e Hold value at its last good value e Set value by using Cfg_PVReplaceVal When Inp_FuncCheck is se
5. 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 EnablelnFalse routine executes Structured Text No effect The instruction s Logic routine executes Inp_Raw REAL a M Input signal from transmitter or sensor raw units Inp_ModFault BOOL 1 1 0 module failure or module communication status bad 0 0K Inp_ChanFault BOOL 1 1 0 channel fault or failure 0 0K Inp_OutOfSpec BOOL 1 Out of specification PV uncertain from instrument 0 0K Inp_FuncCheck BOOL FY 1 Function check PV substituted from instrument 0 0K Inp_MaintRegd BOOL o 1 Maintenance required from instrument Inp_Reset BOOL Input parameter used to programatically reset alarms When set to 1 all alarms requiring reset are reset Cfg_FailOnUncertain BOOL 1 Raise Sts_Fail and alarm if Bad or Uncertain quality 0 Only if Bad quality 10 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan Table 3 P_AlChan Input Parameters Input Parameter Data Type Cfg_PCmdClear BOOL Description Mode Cfg_PCmdClear When this parameter is 1 program commands are cleared once they are acted upon When set to 0 program commands remain set until cleared by the application program logic IMPORTANT Clearing this parameter online can cause unintended program command execution Cfg_HasFailAlm BOOL Fail Cfg_ Exists Th
6. 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 1 0 channel fault 34 1 0 module fault 35 Bad 1 0 configuration for example scaling parameters Rockwell Automation Publication SYSLIB RM042B EN P August 2014 13 Analog Input Channel P_AlChan Table 4 P_AlChan Output Parameters Output Parameter Data Type Alias For Description Val_ Sts SINT Device confirmed status 0 PV Good 5 PV Uncertain 6 PV Bad 7 Substitute PV 33 Disabled Val_ Fault SINT Device fault status 0 none 32 Fail 34 Configuration error 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_PVGood Bo 1 PV quality is Good not flagged as Bad or Uncertain Sts_PVUncertain BOO 1 PV quality is flagged as Uncertain Sts_PVBad Bot fe 1 PV quality is flagged as Bad Sts_Uselnp Bol fe 1 Using input to calculate PV not replaced or held Sts_HoldLast sot fs 1 Analog PV being held at last good value Sts_Clamped Bo 1 Analog PV being clamped at Low or High Limit Sts_Replaced Bo fe 1 Analog PV bei
7. Type FileType FactoryTalk View SE Software FactoryTalk View ME Software Description Graphics Displays GFX RA BAS P_AlChan Faceplate RA BAS ME P_AlChan Faceplate The Channel faceplate used for the object RA BAS P_AlChan Help RA BAS ME P_AlChan Help Help information that is accessed from the P_AlChan faceplate RA BAS Common AnalogEdit Faceplate used for analog input data entry The FactoryTalk View ME faceplates use the native analog input data entry so no file is required RA BAS P_Alarm Faceplate RA BAS ME P_Alarm Faceplate The alarm faceplate display used for the object RA BAS P_Alarm Help RA BAS ME P_Alarm Help P_Alarm Help information that is accessed from the P_AlChan Help faceplate Graphics Global GGFX RA BAS Common Faceplate Objects RA BAS ME Common Faceplate Objects Common global objects used on all Process Objects Object faceplates RA BAS Process Alarm Objects RA BAS ME Process Alarm Objects Global objects used for managing alarms on Process Object faceplates RA BAS Process Faceplate Analog Objects RA BAS ME Process Faceplate Analog Global Objects used on analog device ae faceplates RA BAS Process Help Objects RA BAS ME Process Help Objects Global objects used for help on Process Objects help displays Graphics Images PNG 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 faceplates for all Proce
8. the misconfigured item is flagged with this indicator or appears in a magenta box For the P_AIChan instruction the Invalid Configuration indicator appears under any of the following conditions Input raw minimum and maximum scaling parameters are set to the same value Scaled EU minimum and EU maximum scaling parameters are set to the same value The Out of range On delay timer or the Out of range Off delay timer is set to a value less than or greater than 2 147 483 seconds The Stuck value timer is set to a value less than zero or greater than 2 147 483 seconds Alarm Minimum On Time or Shelf Time is set to a value less than zero or greater than 2 147 483 seconds Alarm Severity is set to a value less than 1 or greater than 1000 A deadband is set to a value less than zero 18 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan One of these symbols appears on the Alarms tab to indicate the described alarm condition The alarm border and label background blink if acknowledgement of an alarm condition is required 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 alarm has not been acknowledged Low severity alarm Yellow Medium severity alarm High severity alarm Magenta Urgent severi
9. you can configure the description label tag and PV units for the device Configure Device Description Label and Tag Raw Input Scaling Input Scaled Maximurmn 20 00 100 00 g Configure Scaled Input Miinimniurm 400 0 00 Maximum Minimum Units m s DO E KA a Raw and Scaled Units Fall if Bad or Uncertain quality unchecked will fall on Bad quality Y Clear Program commands upon receipt Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan The following table lists the functions on page 1 of the Engineering tab Table 13 Engineering Tab Page 1 Description Function Action Security Configuration Parameters Description Type the device description to show Engineering Cfg_Desc on the Faceplate title bar Configuration Code E Label Type the label to show on the graphic Cfg_Label symbol Tag Type the tag name to show on the Cfg_Tag faceplate title bar and in the Tooltip IMPORTANT Pausing the mouse over this field displays a tool tip with the configured Logix tag path Raw Input Scaling Type the range of the signal Input Maximum connected to the Inp_ PV Input The Raw Min default is 4 0 and the Raw Raw Input Scaling Max default is 20 0 Input Minimum EXAMPLE Ifyour input card provides a signal from 4 0 20 0 mA set Cfg_InpRawMin to 4 0 and Cfg_InpRawMax to 20 0 The Raw minimum maximum and engineering units minimum maximum a
10. 2 Description Provides information to assist with equipment procurement for your PlantPAx system Provides characterized recommendations for implementing your PlantPAx system Provides general considerations for the Rockwell Automation 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 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 RM042B EN P August 2014 Analog Input Channel P_AlChan The P_AIChan Analog Input Channel Add On Instruction monitors one analog input channel and provides one configurable alarm There are no dedicated display elements for this instruction The faceplate is called from the associated analog input instructio
11. At http www rockwellautomation com support you can find technical and application notes sample code and links to software service packs You can also visit our Support Center at https rockwellautomation custhelp com for software 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 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 numbe
12. Reference Manual PlantPAx Process Automation System Rockwell Automation Library of Process Objects Analog Input Channel P_AlChan Version 3 1 D Allen Bradley Rockwell Software Automation 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 A
13. acknowledge the alarm Refer to the Rockwell Automation Library of Process Objects Common Alarm Mode P_Alarm Reference Manual publication SYSLIB RM002 for more information Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan Analog Input Channel Faceplate Help Faceplate Help Analog Input Channel Faceplate Help Status Indicators DE Invalid Configuration x Communication Failure A Communication Uncertain Input has been Disabled ls Value Infinite or Mot a Number We Value is being Held at last good value Level Indicators High High Level Exceeded A High Level Exceeded Alarms Device Fail Alarm Alarm Inhibit Suppressed or Disabled Y Maintenance Bypass Active cn Device in Simulation or Test EN Value Clamped to minimax Value has not changed Stuck ea Value is being replaced Loy Low Level Exceeded we Low Level Exceeded This alarm triggers when the Rav Process Value remains above the Out of Range High limit or below the Out of Range Low limit for a specified period of time The Alarm also triggers when the input PY signal quality is bad Rockwell Automation Publication SYSLIB RM042B EN P August 2014 33 Analog Input Channel P_AlChan Notes 34 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Rockwell Automation Support Rockwell Automation provides technical information on the Web to assist you in using its products
14. alarm severity from Highest to Urgent Operations added Simulation section 16 added threshold indicators table 22 Changed Alarm Severity level 4 to Urgent 19 31 Added information about contents of the faceplate title bar 20 Operator faceplate added Alarm Locations image 22 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 RM042B EN P August 2014 5 Preface These documents contain additional information concerning related products Additional Resources from Rockwell Automation Resource PlantPAx Process Automation System Selection Guide publication PROCES SG001 PlantPAx Process Automation System Reference Manual publication PROCES RM001 Rockwell Automation Library of Process Objects publication PROCES RM002 FactoryTalk View Machine Edition User Manual publication VIEWME UM004 FactoryTalk View Site Edition User Manual publication VIEWSE UM006 Logix5000 Controllers Add On Instructions Programming Manual publication 1756 PM010 Rockwell Automation Library of Process Objects Common Alarm Block P_Alarm Reference Manual publication SYSLIB RM00
15. and then the EntryStatus parameter The top four bits of the EntryStatus parameter are checked to make sure they do not equal 2 0100_xxxx_xxxx_xxxx The 0100 pattern indicates the connection is Running All other values are considered faulted Flow Indicator 103 Channel Flow Indicator 103 Fl_ 103 Chan FI_ 103 P_AlChan SN P_Aln Analog Input Channel Analog Input Feedwater Flow SrcQ D orca fo g Inp_PVSreq Rockwell Automation Publication SYSLIB RM042B EN P August 2014 17 Analog Input Channel P_AlChan Displ ay Elements The P_AIChan instruction is used in association with other device instructions to provide input monitoring functions There are no dedicated display elements for this instruction The faceplate is called from the associated instruction s faceplate Status Quality Indicators These symbols appear on the faceplate display when the described condition is true Graphic Symbol Description F4 Invalid configuration K 1 0 communication fault 3 Input or PV uncertain a The device is disabled Enableln false No symbol displayed 1 0 communication OK and configuration valid TIP When the Invalid Configuration indicator appears you can find what configuration setting is invalid by following the indicators 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
16. at indicate a particular configuration error Ifany Err_ bit is set then the Sts_Err configuration error summary status is set and the Invalid Configuration indicator is displayed on the HMI e Alarm data elements Alm_ are outputs of the instruction that indicate a particular alarm has occurred e Acknowledge data elements Ack_ are outputs of the instruction that indicate the corresponding alarm has been acknowledged e Ready data elements Rdy_ are bit outputs of the instruction used by the HMI to enable or disable Command buttons and Setting entry fields Table 4 P_AlChan Output Parameters Output Parameter Data Type Alias For Description EnableOut BOOL Enable Output The EnableOut signal is not manipulated by this instruction Its output state always reflects Enableln Input state Val_InpRaw REAL Analog input value raw units before scaling or checking Val PV value engineering units Val_PVEUMin Minimum of scaled range minimum Cfg_PVEUMin Cfg_PVEUMax Val_PVEUMax Maximum of scaled range maximum Cfg_PVEUMin Cfg_PVEUMax SrcQ_l0 SINT 1 0 signal source and quality SrcQ Final channel status source and quality G00D 0 1 0 live and confirmed good quality 1 1 0 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
17. b d A Instrument Out of Spec 4 b d a Function Check e Y A Input Stuck SN A b d Maintenance Required A Y A U Use Input G Good Quality Hold Input A Uncertain pe Replace P x Bad Quality The following table shows the functions on page 2 of the Engineering tab Table 14 Engineering Tab Page 2 Description Function Invalid Configuration Action Use Input Hold Input or Replace PV Invalid Configuration Quality Good Quality Uncertain or Bad Quality Channel Fault Action Use Input Hold Input or Replace PV When the P_AlnChan configuration is not valid e Use the input to determine value e Hold value at its last good value e Set value by using Cfg_PVReplaceVal Engineering Cfg_CfgErrAction Configuration Code E When the P_AlChan configuration is not valid Cfg_CfgErrQual SetSts_PVGood e SetSts_PVUncertain SetSts_PVBad When there is a channel fault e Use the input to determine value e Hold value at its last good value Set value by using Cfg_PVReplaceVal Cfg_ChanFaultAction 28 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Table 14 Engineering Tab Page 2 Description Function Channel Fault Quality Good Quality Uncertain or Bad Quality Module Fault Action Use Input Hold Input or Replace PV Module Fault Quality Good Quality Uncertain or Bad Quality Input not a Number Action Use Input Hold Input
18. band to clear the Out of seconds Minimum time Out of Range to raise Status seconds 24 Range fail condition The off delay time is used to prevent a chattering fail detection on a noisy signal near a range threshold Type the amount of time the input must stay beyond a range threshold to cause an Out of Range fail condition The on delay time is used to avoid an unnecessary fail detection when the input only momentarily exceeds the threshold Cfg_InpOOROnDly Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Table 12 Maintenance Tab Descriptions Function Time with no change in Input to raise Stuck Status Input Out of Range Fail Threshold Maximum and Minimum Input Out of Range Fail Deadband PV Clamping Limits EU Low PV Clamping Limits EU High Type the amount of time the input must remain unchanged to trigger a stuck input condition A value of zero means the input must change every instruction scan to avoid a stuck input condition Type a large value to disable stuck input detection Type the thresholds that are considered out of range failed If the PV is greater than or equal to the high threshold or less than or equal to the low threshold for the on delay time it is considered out of range Type the deadband to use with the out of range thresholds If the PV is less than the high threshold minus the deadband and the PV is greater than the low th
19. ct 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 this severity parameter drives only the indication on the global object and faceplate The Alarms and Events definition of severity drives the color and symbol that is used on the alarm banner and alarm summary as well as the value returned by FactoryTalk Alarms and Events display commands Cfg_InpRawMin REAL Input unscaled minimum for scaling raw units Cfg_InpRawMax REAL Cfg_PVEUMin REAL Cfg_PVEUMax REAL 20 0 Input unscaled maximum for scaling raw units Process Variable PV output minimum for scaling engineering units 100 0 PV output maximum for scaling to engineering units TIP The P_AlChan instruction supports reverse scaling either the raw input or engineering scaled range can be reversed maximum less than minimum Cfg_PVHiLim REAL Cfg_PVLoLim REAL Cfg_InpOORHiLim REAL Cfg_InpOORLoLim REAL Cfg_InpOORDB REAL Cfg_InpOOROnDly DINT Cfg_InpOOROFfDly 1 50E 38 PV high clamping threshold engineering units 1 50E 38 PV low clamping threshold engineering units 20 733334 Out of Range fail high limit raw units 3 6666667 Out of Range fail low limit raw units 0 06666667 Out of Range fail high low deadband raw units Minimum time out of range to raise status seconds Minimum time in range to clear out of range status seconds aS
20. d as follows Good Uncertain Bad raises Fail alarm For each condition the following actions can be taken Pass the PV through unchanged e Apply a configured replacement PV value Use the last good PV value Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan 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_AIChan_3_1 00_AOLL5X 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 The following files for this Add On Instruction can be downloaded from the Product Compatibility and Download Center at http www rockwellautomation com rockwellautomation support pcdc page IMPORTANT Files must be imported in the following order image files then global object files and then graphic files This order is required to properly configure the visualization files Table 2 P_AlChan Visualization File Types Application
21. e P_AIChan 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 FT101_Chan Analog Channel Quality dica Alarm Acknowledge arm Severity Indicators Command Button Reset and Acknowledge All Alarm Name 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 The color of the bell icon at the top of the faceplate shows the highest active alarm s severity Table 15 Alarm Severity Color Definitions Color Definition Magenta Urgent Red High Yellow Medium Blue Low White bell icon Alarm has cleared but is unacknowledged Background light gray No alarm Rockwell Automation Publication SYSLIB RM042B EN P August 2014 31 Analog Input Channel P_AlChan 32 The following table shows the function on the Alarms tab Table 16 Alarms Tab Description Alarm Name Click an alarm name to open the associated P_Alarm faceplate None Click to acknowledge the alarm Acknowledge Alarms Code F Click to reset and acknowledge all alarms The Reset and Acknowledge All Alarms button is enabled the panel behind the alarm blinks and the Alarm Acknowledge button is enabled if the alarm requires acknowledgment Click the button with the checkmark to
22. graphic symbol Cfg_RU Raw Units for display on HMI Cfg_Tag Tag name for display on HMI This string is shown in the title bar of the faceplate i This section describes the primary operations for Add On Instructions Operations primary op Modes The P_AIChan instruction does not have modes and does not use an embedded P_Mode Add On Instruction The P_AIChan instruction is used to monitor an analog input Rockwell Automation Publication SYSLIB RM042B EN P August 2014 15 Analog Input Channel P_AlChan 16 Alarms The P_AIChan instruction uses the following alarms implemented by using embedded P_ Alarm Add On Instructions Table 6 P_ AlnChan Alarm Parameters Alarm P_Alarm Name Description Fail Fail The input has a condition that is configured to be flagged as bad or the input has a condition that is configured to be flagged as uncertain and Cfg_FailOnUncertain is true 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 TIP The P_AlChan object s Fail alarm is set to not exist by default If you set this alarm to exist be aware that the P_AlChan object does not have its own display elements Thus you do not have a graphic symbol with flashing border to show and click to call up t
23. he P_AlChan faceplate However you can still get to the P_AlChan instance s faceplate easily when it raises a failure alarm in two different ways e Tie the Sts_PVBad output parameter of the P_AlChan instance to the Inp_PVBad input parameter of the downstream object and enable that object s 1 0 failure alarm Enable the downstream object s navigation to its upstream Channel object When the P_AlChan raises its Fail alarm the symbol for the downstream object flashes Call up the downstream object s faceplate then navigate from there to the P_AlChan faceplate e In the FactoryTalk Alarm and Events alarm setup create a command string for the P_AlChan Fail alarm that opens the P_AlChan faceplate with that instance s tag Instructions for how to do this are included in the alarm set up PDF document that is included in the Rockwell Automation Library download When the alarm occurs open the Alarm Summary screen Double click the alarm in the summary list and the P_AlChan faceplate is displayed Simulation The Analog Input Channel Add On Instruction does not have a Simulation capability Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Programming Example Local 1 1 ChOData Rack1Slot4ModFaut Local 1 1 ChOF ault Inp_ModF ault q Inp_ChanF ault Analog Input Channel P_AlChan Execution The following table explains the handling of instruction execution conditions Table 7 P_AlChan Execution
24. is parameter determines whether the corresponding alarm exists and is checked or if the alarm does not exist and is not used When this parameter is 1 the corresponding alarm exists Cfg_FailResetReqd BOOL Fail Cfg_ResetReqd This parameters determines whether a reset is required to clear the alarm status When this parameter is 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 Fail OCmd_Reset are required to clear Alm_Fail alarm after the alarm is set and the value returns to normal When this parameter is 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 Cfg_FailAckReqd BOOL Fail Cfg_AckReqd This parameter determines whether an acknowledgement is required for an alarm When this parameter is 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 Cfg_FailSeverity INT Fail Cfg_Severity 1000 This parameter determines the severity of each alarm This drives the color and symbol that is used to indicate alarm status on the faceplate and global obje
25. momom 33 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 3 Table of Contents Notes 4 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Software Compatibility and Content Revision Preface This document is updated throughout for version 3 1 of the Rockwell Automation Library of Process Objects Changes for this revision are marked by change bars shown in the right margin Table 1 Summary of Changes Topic Page Changed title from PlantPAx Library of Process Objects to Rockwell Automation Library of Front Cover Process Objects Changed version of Rockwell Automation Library of Process Objects from 3 0 to 3 1 5 9 10 Changed references to Knowledgebase Answer ID 62682 to Product Compatibility and Download 5 9 Center Visualization Files 9 added Important note concerning the order files are to be imported Types table added Optional Graphic Displays section to table Input Parameters table 10 added Alias For column and aliases Cfg_lOFaultSeverity changed level 4 alarm severity from Highest to Urgent changed Alarm Severity from 1 4 to 1 1000 changed descriptions for PCmd_ lt Alarm gt Ack PCmd_ lt Alarm gt Suppress PCmd_ lt Alarm gt Unsuppress and PCmd_ lt Alarm gt Unshelve Output Parameters table 13 added SrcQ_ Err_ Ack_ and Alm_ parameter descriptions to bullet list added Alias For column and aliases Val_Notify changed level 4
26. n faceplate Add On Instruction Faceplate P_AIChan FT101_Chan Analog Channel Quality Analog Input Channel Val_InpRaw np ModF aut fal Sts PGood Home Operator Operator inp ChanFault sts PyUncertain sts PyBad ats Uselnp sts HoldLast Sts_Clamped H 20 73 sts Replaced Sts MaintRegd Raw Pi Sis Err from Input 95 79 m DC L 3 67 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan Guidelines This instruction is usually associated with other instructions with one instance being used for each analog input of the associated instruction This instruction can be integrated with the following instructions in the Rockwell Automation Library of Process Objects Basic Analog Input P_AIn Advanced Analog Input P_AInAdv Dual Sensor Analog Input P_AInDual Multiple Analog Input P_AInMulti Flowmeter Dosing P_DoseFM Weigh Scale Dosing P_DoseWS Functional Description The P_AIChan Add On Instruction monitors one analog input channel for the following conditions Invalid configuration I O module fault Input out of range Instrument reports the following conditions Out of specification uncertain Function check substitute PV entered manually Maintenance required Channel fault Input not a number floating point exception Input stuck unchanging For each condition the Process Variable PV quality to report can be configure
27. nalog input failure Bad Uncertain Alm_Fail 1 Analog input failure alarm Bad Uncertain Ack_Fail 1 Analog input failure alarm has been acknowledged Sts_FailDisabled 1 Analog input failure alarm is disabled by Maintenance Sts_FailSuppressed 1 Analog input failure alarm is suppressed by Program Sts_FailShelved 1 Analog input failure alarm is shelved by Operator Rdy_Reset AN 1 At least one alarm requires reset Rdy_ResetAckAll Bot fs 1 At least one alarm requires reset or acknowledgement P_AlChan AN Unique parameter name for auto discovery Analog Input Channel 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 RSLogix 5000 software 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 RSLogix 5000 software export import functionality Table 5 P_AlChan Local Configuration Tags Cfg_Desc STRING_40 Analog Channel Description for display on HMI This string is shown in the title bar of the faceplate Quality Cfg_EU Engineering units for display on HMI Cfg_Label Label for graphic symbol displayed on HMI This string appears on the
28. ng replaced with configured value Sts_InpOORHiCmp Bot fs 1 Input PV exceeds out of range High limit Sts_InpOORLoCmp Bot fe 1 Input PV exceeds out of range Low limit Sts_InpOutOfRange AN 1 Input is out of range includes On delay deadband Off delay Sts_InpStuck BO 1 Input is stuck unchanging Sts_InpNaN Bo 1 Input is not a number floating point exception Sts_ModFault AN 1 1 0 module fault condition Sts_ChanFault sol fs 1 1 0 channel fault condition Sts_OutOfSpec Bot fe 1 Working outside specifications from instrument Sts_FuncCheck Bo 1 Function check PV simulated replaced at instrument Sts_MaintReqd sol fs 1 Maintenance is required from instrument Sts_Alminh Bo 1 An alarm is inhibited disabled or shelved display icon Sts_Err Bo fe 1 Error in configuration see detail Err_ bits for reason display icon Err_Raw BO 1 Error in configuration raw input scaling minimum maximum Err_EU Bol fe 1 Error in configuration scaled engineering units minimum maximum Err_ Timer Bo 1 Error in timer preset must be 0 2 147 483 Err_DB BO 1 Error in configuration a status deadband is lt 0 0 Err_Alarm EN 1 Error in configuration alarm minimum on time shelf time or severity 14 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan Table 4 P_AlChan Output Parameters Output Parameter Data Type AliasFor Description Sts_Fail 1 A
29. r Personal Protective Equipment PPE Follow ALL Regulatory requirements for safe work practices and for Personal Protective Equipment PPE gt gt gt Allen Bradley Rockwell Software Rockwell Automation RSLogix Logix5000 FactoryTalk PlantPAx and ControlLogix are trademarks of Rockwell Automation Inc Trademarks not belonging to Rockwell Automation are property of their respective companies Preface Analog Input Channel P_AlChan Table of Contents Software Compatibility and Content RevisiON ooooooomomomo 5 Additional Resources lt 4 oi ccvsucdec Ga sau ced dav eek tiudewsioeiceaed 6 te he sini Ass Been oe eaten dde ee D 8 Funcional Descrip E a E TOE 8 SS on AER 9 Controller Fil ii 30423 cite donostia laderas 9 Visualizaci n Blesa ias 9 Controller Code susana a ios ds 10 Analog Input Channel Input Structure o oooooooomomomo m 10 Analog Input Channel Output Structure o ooocoooomomomom 13 Analog Input Channel Local Configuration Tags 15 Iran tiara ire dto E E 15 A A 15 A a E A A O A 16 Saula Ees e aa a aa EA dates eE ied 16 ES OW EEE A ed N las 17 Proprambuns Explorar toas 17 Display Element radar a 18 Status QUE MGICAtOls cegado rraprisssicanda 18 o cser irern A orees weet 21 Operator Taboran ner an aed eniseeesaoeneddasawnenieade 22 Maintenance Taba odiada one 24 Poengene LabDisatuisepotaronisrias diia 26 A O O E TO 31 Analog Input Channel Faceplate Help ooooooococoo
30. r 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 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 S Kar Plaza Is Merkezi E Blok Kat 6 34752 erenk y Istanbul Tel 90 216 5698400 www rockwellautomation com Power Control and Information Solutions Headquarters Americas Rockwell Automation 1201 South Second Street Milwaukee WI 53204 2496 USA Tel 1 414 382 2000 Fax 1 414 382 4444 Europe Middle East Africa Rockwell Automation NV Pegasus Park De Kleetlaan 12a 1831 Diegem Belgium Tel 32 2 663 0600 Fax 32 2 663 0640 Asia Pacific Rockwell Automation Level 14 Core F Cyberport 3 100 Cyberport Road Hong Kong Tel 852 2887 4788 Fax 852 2508 1846 Publication SYSLIB RM042B EN P August 2014 Supersedes Publication SYSLIB RM042A EN P December 2013 Copyright 2014 Rockwell Automation Inc All rights reserved Printed in the U S A
31. re used for scaling to engineering units e fg_InpRawMax e fg_InpRawMin Raw Input Scaling Type the PV range represented by the Scaled Maximum input signal connected to Inp_PV The PV engineering units minimum Raw Input Scaling default is 0 0 and the PV engineering Scaled Maximum units maximum is 100 0 EXAMPLE If your input card provides a signal from 4 20 mA that represents 50 250 C set Cfg_PVEUMin to 50 0 and Cfg_PVEUMax to 250 0 The Raw Min Max and PV engineering units Min Max are used for scaling to Engineering Units Cfg_PVEUMax Cfg_PVEUMin Input Units Type the units of measure for the input signal mA DC is the default Cfg_RU Scaled Units Type the engineering units for display Cfg_EU on the HMI Percent 0 is the default Fail if Bad or Check to trigger a failure condition Cfg_FailOnUncertain Uncertain quality and alarm when the PV status is unchecked will fail either Bad or Uncertain on Bad quality Clear this checkbox to trigger the failure condition when only the PV Status is Bad Clear Program Check to clear program commands on Cfg_PCmdClear Commands upon receipt receipt Rockwell Automation Publication SYSLIB RM042B EN P August 2014 27 Analog Input Channel P_AlChan Engineering Tab Page 2 FT101_Chan Analog Channel Quality Invalid Configuration Channel Fault r T Module Fault A bd Input not a Number vr A Input out of Range T
32. reshold plus the deadband for the off delay time it is considered in range not failed The deadband must be greater than or equal to zero Type the low clamping limit for the PV This clamps limits the PV so it does not go below this value IMPORTANT Out of Range detection uses the PV value before clamping This entry does not affect Out of Range detection Type the high clamping limit for the PV This clamps limits the PV so it does not exceed this value IMPORTANT Out of Range detection uses the PV value before clamping This entry does not affect Out of Range detection Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan Configuration amp Tuning Maintenance Code D Cfg_StuckT Disable Alarms Bypass Permissives and Interlocks Code H e Cfg_InpOORHiLim e fg_InpOORLoLim Cfg_InpOORDB Configuration Cfg_PVLoLim amp Tuning Maintenance Code D Cfg_PVHiLim 25 Analog Input Channel P_AlChan Configure Raw Input Maximum Minimum 26 FT101 Chan Analog Channel Quality 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 two pages Engineering Tab Page 1 On Page 1 of the Engineering tab
33. ss Objects When PNG graphic formats are imported they are renamed like a BMP file but retain a PNG format Rockwell Automation Publication SYSLIB RM042B EN P August 2014 9 Analog Input Channel P_AlChan Table 2 P_AlChan Visualization File Types Application Type File nd View SE Software FactoryTalk View ME Software Description HMI Tags FTVME_PlantPAxLib_Tags_3_1_00 cyl These tags must be imported into the FactoryTalk View ME project to support switching tabs on any Process Object faceplate 1 The service release number boldfaced can change as service revisions are created Controller Code This section describes the parameter references for this Add On Instruction Analog Input Channel Input Structure Input parameters include the following e Input data elements Inp_ are typically used to connect field inputs from I O modules or signals from other objects e Configuration data elements Cfg_ are used to set configurable capabilities and features of the instruction e Commands PCmd_ OCmd_ MCmd_ are used by program logic operators and maintenance personnel to request instruction actions Table 3 P_AlChan Input Parameters Input Parameter Data Description Type Enableln BOOL 1 Ladder Diagram If the rung in condition is true the instruction s Logic routine executes If the rung in condition is false the instruction s EnablelnFalse routine executes Function Block Diagram If true
34. t e SetSts_PVGood e SetSts_PVUncertain SetSts_PVBad When the input is stuck not changing e Use the input to determine value e Hold value at its last good value Set value by using Cfg_PVReplaceVal Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan Cfg_ChanFaultQual Cfg_ModFaultAction Cfg_ModFaultQual Cfg_InpNaNAction Cfg_InpNaNQual Cfg_InpOORAction Cfg_InpOORQual Cfg_FuncCheckAction Cfg_FuncCheckQual Cfg_InpStuckAction 29 Analog Input Channel P_AlChan Table 14 Engineering Tab Page 2 Description Function Action Security Configuration Parameters Input Stuck When the input is stuck Engineering Cfg_InpStuckQual Quality Good not changing Configuration Quality Uncertain Set Sts_PVGood Code E or Bad Quality e Set Sts_PVUncertain e Set Sts_PVBad Maintenance When Inp_ MaintReqd is set Cfg_MaintRegdAction Required Action e Use the input to determine value Use Input Hold e Hold value at its last good value Input or Replace PV e Set value by using Cfg_PVReplaceVal Maintenance When Inp_MaintReqd is set Cfg_MaintRegdQual Required Quality SetSts_PVGood Good Quality e SetSts_PVUncertain Uncertain or Bad e Set Sts_PVBad Quality 30 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan Alarms Tab The Alarms tab displays each configured alarm for th
35. ters table on page 13 for details Home Operator Reset and Acknowledge All Alarms Command Button 100 00 Status Indicator H 20 73 Raw Py from Input 3617 q a Current PV mA DC L 367 4 00 0 00 The following table lists the functions on the Operator tab Table 8 Operator Tab Descriptions Function Security Required Click to reset and acknowledge all alarms Acknowledge Alarms Code F Rockwell Automation Publication SYSLIB RM042B EN P August 2014 21 Analog Input Channel P_AlChan These indicators show the PV has exceeded a threshold Table 9 P_ AlChan Threshold Indicators Graphic Symbol Description A High threshold exceeded Y Low threshold exceeded Table 10 P_AlChan Status Indicators Graphic Symbol Description Input Value clamped to minimum maximum Value infinite or not a number Value is being held at last good value Value has not changed stuck Value is being replaced An Alarm indicator appears on the Operator tab when the corresponding alarm occurs FT101_Chan Analog Channel Quality SES 20 00 gt 100 00 H 20 73 Raw Pr E from Input E ETE 10 47 z ag mA DC W L 3 67 400 o 00 Fail Alarm 22 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan The following table shows the alarm status symbols used on the Operator tab Table 11 Operator Tab Alarm Status
36. to suppress alarm p cmg ar Unsuppress os pone SUP DIES Set PCmd_ lt Alarm gt Unsuppress to 1 to unsuppress alarm e These parameters reset automatically When Cfg_PCmdClear is 0 e Set PCmd_ lt Alarm gt Suppress to 1 to suppress alarm Set PCmd_ lt Alarm gt Suppress to 0 to unsuppress alarm e PCmd_ lt Alarm gt Unsuppress is not used e These Parameters do not reset automatically PCmd_FailUnshelve ee PCmd_Unshelve Set PCmd_ lt Alarm gt Unshelve to 1 to Unshelve alarm e The parameter is reset automatically PCmd_ Reset BOOL e Set PCmd_Reset to 1 to reset all alarms requiring reset e This parameter is always reset automatically OCmd_Reset BOOL Operator command to reset all alarms requiring reset OCmd_ResetAckAll Operator command to acknowledge and reset all alarms 12 Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Analog Input Channel P_AlChan Analog Input Channel Output Structure Output parameters include the following e Value data elements Val_ are numeric outputs of the instruction for use by the HMI Values also can be used by other application logic or software packages e Source and Quality data elements SrcQ _ are outputs of the instruction used by the HMI to indicate PV source and quality e Status data elements Sts_ are bit outputs of the instruction for use by the HMI Status bits also can be used by other application logic e Error data elements Err_ are outputs of the instruction th
37. ty alarm No symbol No change in color No alarm or alarm inhibit condition and all alarms are acknowledged Rockwell Automation Publication SYSLIB RM042B EN P August 2014 19 Analog Input Channel P_AlChan Faceplate 20 The P_AIChan faceplate consists of four 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 Tag Description The Operator tab is displayed when the faceplate is initially opened Maintenance Alarms Exit lt 2 oo i l p j eZ EX Operator Engineering Help The faceplate provides the means for operators maintenance personnel engineers and others to interact with the P_AIChan instruction instance When a given input is restricted via Factory Talk View security the required user security code letter is shown in the tables Rockwell Automation Publication SYSLIB RM042B EN P August 2014 Input Bar Graph Raw Input Out of Range High and Low Values Input Source and Quality Indicator gt FT101_ Chan Analog Channel Quality 20 00 Analog Input Channel P_AlChan Operator Tab The faceplate initially opens to the Operator Home tab From here an operator can monitor the device status The Operator tab shows the following information e Current PV value in raw and engineering units e PV status e Input Source and Quality indicator see SrcQ in the Output parame
38. utomation 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 gt gt 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 prope
Download Pdf Manuals
Related Search