Home

Logix5000 Controllers Add-on Instructions Programming Manual

1. Topic Page About Add On Instructions 11 Data Type 15 Help 18 Instruction Size 22 REAL data types are allowed for 1756 L7xS controllers 37 Project Documentation 63 Rockwell Automation Publication 1756 PM010E EN P September 2012 1 Summary of Changes Notes 2 Rockwell Automation Publication 1756 PM010E EN P September 2012 Preface Designing Add On Instructions Table of Contents Studio 5000 Engineering and Design Environment and Logix Designer Application 4 eticuswiwconaiee se aie eek Vavewives Purpose of This Manual 22 2555n04 22 23 2eeteseeasnenesss3s Masao Additional Resources for Safety Applications 2 000 Understanding Tetiiology cians sso iehol ee vh een antes Melee Chapter 1 Tntrod cti n x enren tha va oaddansg weeds A geet eae About Add On Instructions cccccececceccceeveceeenees Components of an Add On Instruction 0 cess eee e eens General Information 34 44 sts0 otal soar ome aneare aids Stacie dd aroricens hs Parameters lt 2 o anin a Redes dw epee estas hae x Local Gs aini arderd hat aioli at eunty pee EE ne ondaterd Dara Type a2 scan desaswleds iss pane rin Ronde ease eae eae Lope ROUTINE pereg na epona sega E E S Optional Scan Mode Routines 45 25 oi0ic Uh ele ereere Instruction Signature sid tick ctn esas tenG Ga eaee rs coeee Sighat re HIStory oer nen acinar saa ens soe E A a Change Historyssa isse eos siia EEE NORE sll A E E E Considerat
2. 000 eee Intended Behavior Agta tisiug aos Poe Sears dale dies eerie Rockwell Automation Publication 1756 PM010E EN P September 2012 Table of Contents Defining Add On Instructions Param ters ucene n e Meso ae VE Be ie Pee eee 32 Naming Conventions ke seesi eesosa e A coe a S 32 Source Protection vew en eshte iaa i E E a 32 Nesting Reuse Instructions snuse date v etn one viee avalos 33 Local TAGs ns cut a chee eh alia Le ta aes a A o EERS 33 Programming Languages 0 135 ceradaraieuhieandeevaekeaoe sees 33 Scan Mode Routines sancnscie doa Seatetaneae saa datiaded poreenehs 34 AE an E E N TE Oe E T 34 Help Documentation lt sos ioiosisesi creisse ar k n A 34 Chapter 2 lntrod ction e rasie rn a E a T a Oke a a aaae 35 Creating an Add On Instruction iow recede eet ities caweeuews cars 35 Creatinga Parameter sated uti cst esata tae E E RA 37 Creating Local lags siniutenaauattatte oaa E hh sw lu nuane tana 39 Editing Parameters and Local Tags a cuckstiimeiay es seeawearks 41 Updates to Arguments Following Parameter Edits 4 Copying Parameter or Local Tag Default Values 00 43 Creating Logic for the Add On Instruction 0 00008 44 Execution Considerations for Add On Instructions 44 Optimizing Performance iis naiessoauveactiinsy iste 45 Defining Operation in Different Scan Modes 0 00008 45 Enabling Scan Modes aviv iveeneteas stair chain ee de
3. Add On Instruction Definition Simulation_DT_1st General Parameters Local Tags Scan Modes Signature Change History Help Noms EEE Description Simulation instruction which includes a dead time and a first order lag Type F Function Block Diagram Change Type Major Minor Extended Text Revision 1 jo gt SimDT 1st Revision Note Vendor Rockwell Automation t parameters and local tag ose value ere moditied to all tags of this instruction type 66 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Figure 11 Simulation Example Definition Editor Parameter Tab Add On Instruction Definition Simulation_DT_1st v1 0 Sim DT General Parameters Local Tags Scan Modes Signature Change History Help Usage Data Type Style__ Req Vis Description ExtemalAccess Constant Enableln Input BOOL 1 Decimal o eae Input Read Only EnableOut Output BOOL OfDecima F Enable Oupu Read Only Simlnput Input REAL 0 0 Float M Enter the tag Read write SimDeadti Input REAL 0 0 Float Enter the dea Read write SimTimeC Input REAL 1 0 Float C M Enter the time Read Write SimOutput Output REAL 0 0 Float Output value Read Only aonn oog SimDTInv Output BOOL 9 Decimal If on the dea Read Only FDAT InQut REAL 100 E Float
4. Simulation_DT_1Simulation instruction which includ Relay Ladder Motor_Starter Starts and stops a motor IV Show Language Elements By Groups Ok Cancel New Add On Instruction Help Including an Add On Instruction Follow this procedure when you want to use an Add On Instruction in one of ina Routine your routines 1 Open the Add On Instruction folder in the Controller Organizer and view the listed instructions If the instruction you want to use is not listed you need to do one of the following Create the instruction in your project Copy and paste an instruction into your project Get the file for an exported instruction definition and then import the instruction into your current project 2 Open the routine that will use the instruction 3 Click the Add On tab on the instruction toolbar 4 Click the desired Add On Instruction for example Simulation and drag the instruction from the toolbar into the routine Simulation_DT_1st 25 Simulation instruction which includes a D Q Siminput SimDTiny g SimTimeConstant SimOutput D T 5 Define arguments for each Parameter on the instruction call Rockwell Automation Publication 1756 PM010E EN P September 2012 73 Chapter 3 The instruction appears as follows in each of the languages Ladder Diagram Simulation_DT_1st Simulation instruction which includes Simulation_DT_1st Sim
5. 5 Click Export Rockwell Automation Publication 1756 PM010E EN P September 2012 87 Chapter 4 Importing an Add On This exports the selected Add On Instruction and all the referenced instructions into the same export file This file can be used to distribute an Add On Instruction When the exported Add On Instruction is imported into the project the referenced instructions are imported as well in one step You can import an Add On Instruction that was exported from another RSLogix 5000 project When importing an Add On Instruction the parameters Instruction i local tags and routines are imported as part of the Add On Instruction Once the project has the Add On Instruction you can use it in your programs Import Considerations ATTENTION Editing an L5K or L5X File ATTENTION The EditedDate attribute of an Add On Instruction must be updated if the Add On Instruction is modified by editing an L5K or L5X file If the Logix Designer application detects edits to the Add On Instruction but the Edited Date attribute is the same the Add On Instruction will not be imported When importing Add On Instructions directly or as references consider these guidelines Topic Consideration Tag Data Imported tags that reference an Add On Instruction in the import file may be affected if the Add On Instruction is not imported as well In this case the imported tag s data may be converted if the existing Add On Instruction
6. Enter an aray I a Move Up Move Down Copy all default values of parameters and local tags whose values were modified to all tags of this instruction type Data Type Size 276 byte s Sprly He Figure 12 Simulation Example Logic DEDT_01 DEDT wa Deadtime LOLG maf Simulation Output Prania SimOutput Dead Time Invalid E Simulation Input C Deadtime Deadtimelnv D StorageArray Time Constant Sec 10 iSimTimeConstant D Rockwell Automation Publication 1756 PM010E EN P September 2012 67 Chapter 2 68 Ladder Diagram Configuration In this example the instruction simulates a deadtime and lag first order process The Simulation _DT_Ist instruction reads the control variable from the PID instruction The PID instruction reads the SimOutput Parameter of the Simulation _DT_1st instruction Simulation instruction which includes a dead time and a first order lag Simulation_DT_1st Simulation instruction which includes a d Simulation_DT_1st Sim_DT_LD Siminput My_Control_Yariable SimTimeConstant SimOutput DAI Tieback Control Variable PID Master Loop Inhold Bit Inhold Value Setpoint Process Variable Output 00e 50 00e My_Control_variable Sim_DT_LD SimOutput f Simulation_DT_ 1st tag Rockwell Automation Publication 1756 PM010E EN P September 2012 SimOutput Parameter
7. Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Creating Local Tags Figure 3 Add On Instruction Definition Editor Parameters Tab Add On Instruction Definition Motor_Starter v1 0 m General Parameters Local Tags Scan Modes Signature Change History Help Data Type Alias For Default Style Enableln Input 1 Decimal EnableOut Output 0 Decimal Stop Input 0 Decimal Start Input 0 Decimal Input BOOL Decimal AuxContact Input 9 Decimal ClearFault Input 0 Decimal Out Output 0 Decimal Fault Output 9 Decimal FaultT ime Input 9 Decimal 2 Move Down Data Type Size 20 byte s Description Enable Input Sys Enable Output 5 Enter the tag that Enter the tag that Jog command for t Ausiliary contact o To clear the fault Output command t If on the motor di Enter the time ms Extemal Access Constant Read Only Read Only Read Write Read Write Read Write Read write Read Only Read Only Read Write OIAOOb Oso 000 Use the Add On Instruction Definition Editor to create the local tags for your instructions Local tags contain data that will be used by your Add On Instruction but that you do not want exposed to the user of your instruction Local tags do not appear in the data structure for an Add On Instruction because they are hidden members TIP You can a
8. The instruction signature consists of an ID number that identifies the contents of the Add On Instruction and a timestamp that identifies the specific date and time at which the instruction signature was generated or a signature history entry was made whichever came last Add On Instruction Definition Simulation_DT_1st E General Parameters Local Tags Scan Modes Signature Change History Help Signature Generate a signature to uniquely identify this instruction and seal it from modifications Timestamp 2009 06 2217 17 58 29 193Z Add to History Signature History e emae d lo ags of this instruction type Copy all default values of parameters anc Once generated the instruction signature seals the Add On Instruction preventing it from being edited while the signature is in place In addition when a sealed safety Add On Instruction is downloaded for the first time a SIL 3 safety instruction signature is automatically generated The safety instruction signature is an ID number that identifies the execution characteristics of the safety Add On Instruction Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Signature History The signature history provides a record of signatures for future reference A signature history entry consists of the name of the user the instruction signature the timestamp value and a user defined description Up to six history
9. M To simulate a fault Read write DelayTime 2 0 Decimal L Enter the time in m Read write Copy all default values of parameters and local tags whose values were modified to all tags of this instruction type Data Type Size 20 byte s You can also click the copy default values icon to copy default values to all tags of the Add On Instruction data type The icon appears on the watch pane as a context menu data monitor and logic editor when the Data Context is the Add On Instruction s definition If you want to select which specific tags and values to copy click the arrow of the copy default values icon and choose Copy Specified Values Dl Copy All Values Copy Specified Values Rockwell Automation Publication 1756 PM010E EN P September 2012 43 Chapter 2 The Copy Default values dialog box shows the current default values for the parameters and local tags and the instance tags where the Add On Instruction is used or referenced Copy Default Values Simulate_Feedback Default values of selected parameters and local tags in Simulate_Feedback will be copied to specified tags of this type IN Specify which values to copy to which tags Default Values Instances of Simulate_Feedback t Tag Container Routine amp Location V Motor_1_AuxContact B Motor_Starte B Motor_Starte Rung 2 Enableln Vv Conveyor_1_AuxContact amp Motor_Starte B N
10. My_PIDE_ST PV Sim_DJ_STSimOutput PIDE My_PIDE_ST D Sim_DT_ST SimOutput Simulation_DT_1st tag dot SimOutput Parameter Rockwell Automation Publication 1756 PM010E EN P September 2012 69 Chapter 2 Notes 70 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 3 Introduction Accessing Add On Instructions Using Add On Instructions Add On Instructions are used in your routines like any built in instructions You add calls to your instruction and then define the arguments for any parameters Topic Page Accessing Add On Instructions F l Using the Add Element Dialog Box 2 Including an Add On Instruction in a Routine B Tips for Using an Add On Instruction 5 Programmatically Access a Parameter 75 Monitoring the Value of a Parameter 71 Viewing Logic and Monitor with Data Context 79 Determining if the Add On Instruction is Source Protected 81 Copying an Add On Instruction 82 Storing Your Add On Instructions 82 The Add On Instruction can be used in any one of the Ladder Diagram Function Block or Structured Text languages including Structured Text within Sequential Function Chart actions The appearance of the instruction conforms to the language in which it is placed The Add On Instructions in the project can be accessed from any of the normal instruction selection tools The instruction toolbar has an Add O
11. Type Function Block Diagram Instruction Simulation_DT_1st C Open Routine 5 Type a description of the postscan behavior 6 Click OK to create the routine and return to the Scan Modes tab 7 Define if the postscan routine executes or not by checking or clearing Execute Postscan routine after the logic routine is postscanned a Postscan routine Executes on last scan of a step if SFC is configured for automatic reset V Execute Postscan routine after the Logic routine is postscanned The Postscan routine can now be edited like any other routine Rockwell Automation Publication 1756 PM010E EN P September 2012 49 Chapter 2 EnablelnFalse Routine When defined and enabled for an Add On Instruction the EnableInFalse routine executes when the rung condition is false or if the EnableIn parameter of the Add On Instruction is false 0 This is useful primarily for scan false logic when used as an output instruction in a Ladder routine A common use of scan false is the setting of OTEs to the de energized state when the preceding rung conditions are false An Add On Instruction can use the EnableInFalse capability to let you define behavior for the False conditions When the Add On Instruction is executed in the false condition and has an EnableInFalse routine defined and enabled any required parameters have their data passed Values are passed to Input parameters from their arguments in the instruction call
12. s data structure is different and tag data may be lost If an existing Add On Instruction is overwritten project tag data may be converted if the Add On Instruction s data structure is different and tag data may be lost See Import Configuration on page 89 for more information Logic Imported logic that references the Add On Instruction in the import file may be affected if the Add On Instruction is not imported If an existing Add On Instruction is used for the imported logic reference and the parameter list of the Add On Instruction in the project is different the project may not verify or it may verify but not work as expected If an existing Add On Instruction is overwritten logic in the project that references the Add On Instruction may be affected The project may not verify or may verify but not work as expected See Import Configuration on page 89 for more information Add On Instructions While Online An Add On Instruction cannot be overwritten during import while online with the controller although a new Add On Instruction may be created while online Final Name Change If the Final Name of an Add On Instruction is modified during import configuration the edit date of the imported Add On Instruction will be updated In addition all logic tags User Defined Data Types and other Add On Instructions in the import file that reference the Add On Instruction will be updated to reference the new name As a result
13. the edit date of any Add On Instruction that references the Add On Instruction will be updated Add On Instructions that have been sealed with an instruction signature cannot be renamed during import User Defined Data Types Add On Instructions cannot overwrite User Defined Data Types Add On Instructions and User Defined Data Types must have unique names Instruction Signature If you import an Add On Instruction with an instruction signature into a project where referenced Add On Instructions or User Defined Data Types are not available you may need to remove the signature You can overwrite an Add On Instruction that has an instruction signature by importing a different Add On Instruction with the same name into an existing routine Add On Instructions that have been sealed with an instruction signature cannot be renamed during import Safety Add On Instructions 88 You cannot import a safety Add On Instruction into a standard task You cannot import a safety Add On Instruction into a safety project that has been safety locked or one that has a safety task signature You cannot import a safety Add On Instruction while online Class instruction signature signature history and safety instruction signature if it exists remain intact when an Add On Instruction with an instruction signature is imported Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 4 IMPORTANT Importing an Add On Ins
14. An InOut parameter defines data that can be used as both input and output data during the execution of the instruction Because InOut parameters are always passed by reference their values can change from external sources during the execution of the Add On Instruction Input parameter For an Add On Instruction an Input parameter defines the data that is passed by value into the executing instruction Because Input parameters are always passed by value their values cannot change from external sources during the execution of the Add On Instruction Output parameter For an Add On Instruction an Output parameter defines the data that is produced as a direct result of executing the instruction Because Output parameters are always passed by value their values cannot change from external sources during the execution of the Add On Instruction Passed by reference When an argument is passed to a parameter by reference the logic directly reads or writes the value that the tag uses in controller memory Because the Add On Instruction is acting on the same tag memory as the argument other code or HMI interaction that changes the argument s value can change the value while the Add On Instruction is executing Passed by value When an argument is passed to a parameter by value the value is copied in or out of the parameter when the Add On Instruction executes The value of the argument does not change from external code or HMI
15. Atomic for any parameter Arrays and structures must be InOut parameters Parameter checking N A None user must manage Verification checks that correct type of argument has been provided for a parameter Data encapsulation N A All data at program or controller scope Local data is isolated only accessible within instruction accessible to anything Monitor debug In line code with its Mixed data from multiple calls which Single calling instance data which simplifies debugging data complicates debugging Supported programming FBD LD SFC ST FBD LD SFC ST FBD LD ST languages Callable from N A FBD LD SFC ST FBD LD SFC via ST ST Protection Locked and view only Locked and view only Locked and view only Documentation Routine rung textbox Routine rung textbox line Instruction revision information vendor rung textbox line line extended help Execution performance Fastest JSR SBR RTN instructions add overhead Call is more efficient All data is copied InOut parameters are passed by reference which is faster than Indexed reference impact copying data for many types Parameter references are automatically offset from passed in instruction tag location Memory use Most used Very compact Compact call requires more memory than a subroutine call All references need an additional word Rockwell Automation Publication 1756 PM010E EN P September 2012 23 Chapter 1 Table 1 Advantages and Disadvantage
16. Function Block Diagram Editor Ladder Diagram Function Block Diagram Sim_DT _FBD Simulation_DT_1st onveyor_Control Starts and stops a conveyor a Conveyor_Control Conveyor_1_LD CJ GJ Simuation instruction which includes 4 Stop Conveyor_1_Stop_PB i 0 0e Siminput SimDTinv D Start Conveyor_1_Entry_PE Q SimDeactine SimOutpu D 0e e SimTime Constant Out Conveyor_1_Out Sen Re 0e DT_Array FBD Signature ID 3DC08D58 Signature D 337B1C5B You can turn off the display of the instruction signature in the Workstation Options dialog box of the Logix Designer application Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Creating Instruction Help You can also view the instruction signature and the safety instruction signature on the Quick View pane of the Controller Organizer and on the Signature tab of the Instruction Definition Editor dialog box The Add On Instruction name revision instruction signature safety instruction signature and timestamp are printed on the Add On Instruction Signature Listing report You can also choose to include the instruction signature safety instruction signature and signature history on the Add On Instruction report by clicking Print Options on the Generate Report dialog box Custom instruction help is generated automatically as you are creating your Add On Instructions The Logix Designer application automatically builds help for
17. G Instruction Help F1 Neyer Show Description Open Instruction Logic Open Instruction Definition v Logic Sim_Dead_ MainRout le a aj Properties Alt Enter gt The logic routine opens with animated logic for the specific calling instance Verifying Individual Scan Modes The most straightforward method to verify Scan mode operation is to execute the instruction first with the Scan mode routine disabled then again with it enabled Then you can determine whether the Scan mode routine performed as expected Instruction Description True This is simply the execution of the main logic routine False In a ladder logic target routine this entails placing an XIC before an instance of the instruction and evaluating instruction results when the XIC is false In a Function Block target routine this entails executing an instance of the instruction with the Enableln parameter set to zero 0 Prescan Place the controller in Program mode then place it in Run mode Postscan With the controller configured for SFC Automatic Reset place an instance of the instruction into the Action of an SFC Run the SFC such that this Action is executed and the SFC proceeds beyond the step that is associated with this Action You can apply source protection to your Add On Instruction to protect your intellectual property or prevent unintended edits of a validated source With source protection you can limit a user of your Add On Instruction
18. Input and Output parameters Rockwell Automation Publication 1756 PM010E EN P September 2012 27 Chapter 1 28 Creating an Alias Parameter for a Local Tag Alias parameters simplify connecting local tags to an Input or Output tag that is commonly used in the Add On Instruction s application without requiring that manual code be created to make the association Aliases can be used to define an Input or Output parameter with direct access to a local tag or its member Changing the value of an alias parameter changes the data of the local tag or local tag member it represents and vice versa Alias parameters are subject to these restrictions Alias parameters must be either Input or Output parameters You can only create an alias parameter for a local tag or its member Only one Input and one Output parameter may be mapped to the same local tag or the same member of a local tag Only BOOL SINT INT DINT and REAL data types may be used Alias parameters may not be constants The External Access type of an alias parameter matches the External Access type of the local tag to which it is mapped For information on constants and External Access see Data Access Control on page 30 Using a Single Dimension Array as an InOut Parameter The InOut parameter can be defined to be a single dimension array When specifying the size of this array consider that the user of your array can either pass an array tag that is the same s
19. Simulated Level based on Valve Pos LIC101_Sim ProcSim Eal Process Simulation Deadtime gt Lag LIT_104 Simulation Input Eng Units Deadtime Instruction LeadLag Instruction 0 0 Backing Tag Backing Tag DEDT_04 LDLG_01 DEDT ay LOLG pl imulation Output Deadtime Lead Lag Eng Units Deadtime seconds Cfg_DeadTime Lag Time Constant seconds 0 0 Cfg_LagTime m 0 0 Deadtime StorageAray DeadTimeShiftArray Rockwell Automation Publication 1756 PM010E EN P September 2012 15 Chapter 1 16 Optional Scan Mode Routines You can define additional routines for Scan mode behavior Add On Instruction Definition Simulation_DT_ st General Parameters Local Tags Scan Modes Signature Change History Help The controller prescans and postscans the Add On Instruction Logic routine but will not execute the Lagic routine when Enableln is false Optional Prescan Postscan and EnablelnFalse routines may be configured below Prescan routine Executes prior to first scan on transition from program to run New Postscan routine Executes on last scan of a step if SFC is configured for automatic reset New EnablelnFalse routine Executes when the Enableln parameter is false Copy all default values of parameter gs of this instruction type Data Type Size 276 byte s Cancel PPY Instruction Signature
20. Source Protection feature refer to the LogixS000 Controllers Security Programming manual publication 1756 PM016 The Signature tab of the Add On Instruction Definition Editor lets you manage the instruction signature create signature history entries and view the safety instruction signature if it exists Instruction signatures are applied to the definition of the Add On Instruction All instances of that Add On Instruction are sealed when the signature is applied Generating Removing or Copying an Instruction Signature On the Signature tab of the Add On Instruction Definition Editor click Generate to create an instruction signature or Remove to delete the instruction signature Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 You must be offline to generate or remove an instruction signature Both actions change the Last Edited Date IMPORTANT If you remove an instruction signature when the Add On Instruction also has a safety instruction signature the safety instruction signature is also deleted You can click Copy to copy the instruction signature and the safety instruction signature if it exists to the clipboard to facilitate record keeping Signature Generate a signature to uniquely identify this instruction and seal it from modifications ID F98C9DE6 Timestamp 2009 06 22T18 04 18 0152 IMPORTANT If an invalid instruction signature is detected during verification an error messa
21. The Simulation_DT_ 1st instruction reads the control variable from the PID instruction The PID instruction reads the SimOutput Parameter of the Simulation_DT_1st instruction The Simulation_DT_ 1st instruction reads the control variable from the PIDE instruction and calculates an output The output goes to the process variable of the PIDE instruction Function Block Diagram Configuration Chapter 2 The PIDE instruction sends the control variable to the Simulation DT_1st instruction The Simulation_DT_1st instruction calculates an output and sends it to the PIDE instruction as the process variable The PIDE instruction sends the control variable to the Simulation_DT_1st instruction Simuation instruction which includes a dead time and a first order lay Sim _DT_FBD My _PDE_FBD Simulation_DT_1st a Simulation instruction which includes a c Siminput SimOutpus qq PY Q SimDeactime SimDTinv Q SPProg g SimTime Constant g SPCascade RatioProg DT_Array_FBD Enhanced PID ADE w 0 0 q CYProg PY L amp larm D 9 qgFF PYLLAlarm D 3 The Simulation _DT_1st instruction calculates an d HandFB PVROCPosAlarm D output and sends it to the PIDE instruction as the E ProgProgReq PYROCNegAlarm 7 process variable F Eee Risctatitanerbor Structured Text Configuration Simulation_DT_1st Sim_DT_ST My_PIDE Give DT_Array_ST D
22. languages You cannot compare execution times for the same Add On Instruction written in different programming languages There are fundamental differences on how the different languages execute and are compiled TIP You can change the programming language after you create the Add On Instruction by clicking Change Type on the General tab of the Add On Instruction Definition Editor However any existing logic will be lost Transitional Instructions Some instructions execute or retrigger only when rung condition in toggles from false to true These are transitional relay ladder instructions When used in an Add On Instruction these instructions will not detect the rung in transition to the false state When the Enableln bit is false the Add On Instruction logic routine no longer executes thus the transitional instruction does not detect the transition to the false state Extra conditional logic is required to handle triggering of transitional instructions contained in an Add On Instruction Rockwell Automation Publication 1756 PM010E EN P September 2012 21 Chapter 1 22 Some examples of transitional instructions include ONS MSG PXRQ SRT some of the ASCII instructions and some of the Motion instructions TIP The EnablelnFalse routine can be used to provide the conditioning required to retrigger transitional instructions contained in an Add On Instruction However this method will not work for calls to this Add On Instruct
23. lets you review the pending changes before confirming or rejecting them RSLogix 5000 Changes pending for Conveyor_Control instruction require updates to the calls of this instruction Each call will be edited to maintain arguments passed to existing parameters If you choose to apply the changes to the instruction check all locations calling instruction Conveyor_Control to ensure that they will execute correctly with the updates Locations where instruction is called Selected call s arguments Container Routine Location Parameter Argument E Stop Conveyor_1_Stop_PB Start Conveyor_1_Entry_PE JamClear lt Unknown gt Conveyor_1_Out Show Changed Parameters Only This operation cannot be undone Apply changes to the instruction and edit arguments for each call Yes No Help C Open Cross Reference An asterisk identifies parameters with changes pending Existing arguments are reset to the parameters they were originally associated with Newly added parameters are inserted with a in the argument field except for Structured Text where the field is blank Unknown parameters are created for arguments where associated parameters have been deleted To accomplish this update the Logix Designer application tracks the changes made to the Add On Instruction parameters from the original instruction to the final version In contrast the import and paste processes compare only parameter names to associa
24. long you will typically want to use shorter more manageable names Source Protection What type of source protection needs to be defined if any Who will have access to the source key Will you need to manage source protection and an instruction signature Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Source protection can be used to provide read only access of the Add On Instruction or to completely lock or hide the Add On Instruction and local tags Source protection must be applied prior to generating an instruction signature Nesting Reuse Instructions Are there other Add On Instructions that you can reuse Do you need to design your instructions to share common code Local Tags What data is needed for your logic to execute but is not public Identify local tags you might use in your instruction Local tags are useful for items such as intermediate calculation values that you do not want to expose to users of your instruction Do you want to create an alias parameter to provide outside access to a local tag Programming Languages What language do you want to use to program your instruction The primary logic of your instruction will consist of a single routine of code Determine which programming language to use based on the use and type of application Safety Add On Instructions are restricted to Ladder Diagram If execution time and memory usage are critical factors refe
25. not usually need to pass the parameter value out to an argument but you do want to display its value prominently for troubleshooting Required parameters are always visible and InOut parameters are always required and visible All Input and Output parameters regardless of being marked as required or visible can be programmatically accessed as a member of the instruction s tag Figure 1 Simulation Instruction in Function Block Visible non required Boolean Output Parameter Sim_DT_FBD Required Input x Simulation_DT_1st wil Parameter er a Simulation instruction which includes a Visible non required d Siminput SimDTlrw E Output Parameter Q SimDeadtime Sim Output D InOut Parameter Visible non p o SimTimeConstant required Input DT_Aray_FBD Parameter If you want a pin that is displayed in Function Block but wiring to it is optional set it as Visible Figure 2 Simulation Instruction in Ladder Visible non required Boolean Output Visible non Parameter required Input Simulation_DT_1st Simulation instruction which includes a d Parameter Simulation_DT_1st Sim_DT_LD Hsi Siminput My_Control_ Variable DTInv Required Input Visible non 00e Parameter required Output oo Parameter ImOutp DAI DT_Array_LD InOut Parameter lf you want the parameter s value displayed on the instruction face in Ladder set the parameter as visible An Output parame
26. of GuardLogix safety controllers Create a safety Add On Instruction if you need to use your instruction in a safety application Safety Add On Instructions are subject to a number of restrictions These restrictions enforced by the Logix Designer application and all GuardLogix controllers are listed here for informational purposes only They may use only safety approved instructions and data types All parameters and local tags used in a safety Add On Instruction must also be safety class Safety Add On Instructions use relay ladder logic only and can be called in safety routines only which are currently restricted to ladder logic Safety Add On Instructions may be referenced by other safety Add On Instructions but not by standard Add On Instructions Safety Add On instructions cannot be created edited or imported when a safety project is safety locked or has a safety task signature Refer to the GuardLogix Controller Systems Safety Reference Manual publication 1756 RM093 for information on how to certify a safety Add On Instruction as well as details on requirements for safety applications the safety task signature and a list of approved instructions and data types Rockwell Automation Publication 1756 PM010E EN P September 2012 19 Chapter 1 20 Instruction Signature The instruction signature available for both standard and safety controllers lets you quickly determine if the Add On Instruction has been modified E
27. of their respective companies Summary of Changes This manual contains new and updated information IMPORTANT RSLogix 5000 programming software is now known as Studio 5000 Logix Designer application a component of Studio 5000 Engineering and Design Environment The following controllers are no longer supported in the Logix Designer application version 21 Catalog Number Description 1756 L61 ControlLogix 5561 Controller 1756 L61S ControlLogix 5561S Controller 1756 L62 ControlLogix 5562 Controller 1756 L62S ControlLogix 5562S Controller 1756 L63 ControlLogix 5563 Controller 1756 L63S ControlLogix 5563S Controller 1756 L64 ControlLogix 5564 Controller 1756 L65 ControlLogix 5565 Controller 1768 L43 CompactLogix 5343 Controller 1768 L43S CompactLogix 53435 Controller 1768 145 CompactLogix 5345 Controller 1768 L45S CompactLogix 5345S Controller 1769 L23E QBF1 CompactLogix 5323E 0QB1 Controller 1769 L23E QBFC1 CompactLogix 5323E QBFC1 Controller 1769 L23 QBFC1 CompactLogix 5323 QBFC1 Controller 1769 L31 CompactLogix 5331 Controller 1769 L32C CompactLogix 5332C Controller 1769 L32E CompactLogix 5332E Controller 1769 L35CR CompactLogix 5335CR Controller 1769 L35E CompactLogix 5335E Controller Changes throughout this revision are marked by change bars as shown in the margin of this page This table contains the changes made to this revision
28. 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 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 PP gt gt IMPORTANT Identifies information that is critical for successful application and understanding of the product Allen Bradley Rockwell Software Rockwell Automation and TechConnect are trademarks of Rockwell Automation Inc Trademarks not belonging to Rockwell Automation are property
29. signature intact because the switch does not alter the instruction definition it only changes the language that is displayed For more information on enabling a project to support multiple translations of 4 pro PP P project documentation refer to the online help Rockwell Automation Publication 1756 PM010E EN P September 2012 63 Chapter 2 Motor Starter Instruction Example 64 The Motor_Starter Add On Instruction starts and stops a motor If the stop pushbutton is closed and the start pushbutton is pressed then the motor gets the command to run the instruction seals in the command so the motor keeps running even after you release the start pushbutton If the stop pushbutton is pressed opened then the motor stops Figure 4 Motor Starter Example Definition Editor General Tab Add On Instruction Definition Motor_Starter v1 0 oo General Parameters Local Tags Scan Modes Signature Change History Help ox Name Motor Starter Description Starts and stops a motor Extended Text Type e Ladder Diagram Major Minor Revision Revision Note Vendor Rockwell and loc Dora whose values were n Copy all default values of parameter Data Type Size 20 byte s Figure 5 Motor Starter Example Definition Editor Parameter Tab Add On Instruction Definition Motor_Starter v1 0 General Parameters Local Tags Scan Modes Signature Change
30. tags This captures the message configuration data such as type and path In deciding how to manage your Add On Instruction definitions in export files you need to consider your goals in storing the definitionss If Then You want to store many Add On Instructions that share a set of common Add On Export to separate files as Instructions or User Defined Data Types in a common location described on page 86 You want to distribute an Add On Instruction as one file Export to a single file as You want to manage each Add On Instruction as a standalone instruction described on page 87 You want to preserve the instruction signature on your Add On Instruction TIP Add On Instructions with instruction signatures are encrypted upon export to prevent modifications to the export file Rockwell Automation Publication 1756 PM010E EN P September 2012 85 Chapter 4 86 Exporting to Separate Files If you want to store many Add On Instructions that share a set of common Add On Instructions or User Defined Data Types in a common location you may want to choose to export each Add On Instruction and User Defined Data Types to separate files without including references Follow these steps to export to separate files 1 Right click the Add On Instruction in the Controller Organizer and choose Export Add On Instruction 2 Select the common location to store the L5X file Export Add On Instruction Save in Project
31. to read only access or prevent access to the internal logic or local tags used by the instruction You can protect the use and modification of your instructions with a source key file when you distribute them Rockwell Automation Publication 1756 PM010E EN P September 2012 55 Chapter 2 Generating an Add On Instruction Signature 56 You have two options when using source protection Source Protected Users without the source key cannot view any routine or local tags or make any edits to the Add On Instruction Choose this option if you want to protect the source definition of an Add On Instruction from the view of a user This may be due to the proprietary nature of the algorithms or for strict revision control Source Protected with Viewable Option Users without the source key can view all components of the Add On Instruction including its logic and local tags but are prevented from making any edits to the instruction TIP Apply source protection before generating an instruction signature for your Add On Instruction definition You will need the source key to create a signature history entry When source protection is enabled you can still copy the instruction signature or signature history if they exist Enable the Source Protection Feature If source protection is unavailable and not listed in your menus you can enable it by using the RS5SKSrcPtc exe tool on your installation CD For procedures on how to use the
32. your Add On Instructions by using the instruction s description revision note and parameter descriptions By creating meaningful descriptions you can help the users of your instruction In addition you can add your own custom text to the help by using the extended description field You can provide additional help documentation by entering it on the Help tab of the Add On Instruction Definition Editor The instruction help is available in the instruction browser and from any call to the instruction in a language editor by pressing F1 Writing Clear Descriptions When writing your descriptions keep the following in mind Use short sentences and simple language Rockwell Automation Publication 1756 PM010E EN P September 2012 59 Chapter 2 60 Be brief and direct when you write Include simple examples Proofread your entries This is an example of the Extended Description Text field in the Help tab of the Add On Instruction Definition Editor This area lets you create directions on how to use and troubleshoot your instruction The Instruction Help Preview window shows how your text will look as generated instruction help TIP When you are entering your text into the Extended Description Text field you can use returns and tabs in the field to format the text and if you copy and paste text into the field tabs are preserved Add On Instruction Definition Motor_Starter v1 0 EEJ General Parameters Local T
33. 1 Open the Logix Designer project that contains the Add On Instruction 2 Find the instruction in the Add On Instructions folder Controller My_Controller_1 Tasks Motion Groups Add On Instructions Conveyor_Control Motor_Starter Simulate_Feedback 3 Right click the instruction and choose Copy 4 Go to the other project where you want to paste the instruction 5 Right click the Add On Instructions folder and choose Paste Controller My_Controller_2 ogo Tasks 29 Motion Groups Add On Instructions 3 Data Types C3 New Add On Instruction Import Add On Instruction Paste N Ctrl i e There are two ways to store a group of Add On Instructions together One is to oring rour n y group S Instructions save your Add On Instructions in a project file Another is to create an LSX export file as described in Chapter 4 Follow these steps to store your instructions by saving them in a project file P y y 8 pro 1 Identify what instructions you want to store 2 Place them in a project file called something like Mylnstructions ACD 82 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 3 3 Open other projects in additional instances of the application and use copy and paste or drag and drop to move a copy of the instruction from My Instructions ACD to another project If any of these instructions reference the same Add On Instruction or User Defi
34. Description Use this instruction to start and stop a motor The instruction uses a basic stop and start circuit Ifthe Stop button is closed the motor gets the cornmand to run when you press the Start button The motor runs even after you release the Start button The motor stops when you press open the Stop button Use the Jog bit to jog the motor The Jog bit overrides the Stop button Remove ID 48F181FC Timestamp 2009 07 31700 14 35 449Z Add to History if Signature History User Signature ID__ Timestamp You can also use the auxiliary contact of the motor to make a fault happen if the motor doesn t start or stop In FaultTime enter how long you want to wait for the contact to open or close Enter the time in milliseconds The Fault bit turns on if the contact doesn t show that the motor started or stopped within the FaultTime You must set FaultTime greater than O to use the auxiliary contact Otherwise the instruction doesnt use the value of the auxiliary contact To clear the Fault bit turn on the FaultClear bit The instruction doesnt let you enter tags for the Jog AuxContact and FaultClear bits in the LD and ST programming languages You must write code to turn those bits on and off For example In LD use XIC and OTE instructions to read the value of the auxiliary contact tag and write it to the AuxContact bit In ST use an assignment to set the AuxContact bi
35. E EN P September 2012 77 Chapter 3 a For either a Function Block or Ladder Diagram click Properties E for the instruction lotor_Starter Starts and stops a motor Motor_Starter Motor_Starter_LD Stop Stop_PB Start Out Motor_Out_LD 0e b For Structured Text right click the instruction name and choose Properties X g Name Argument vae Data Type Description Enableln BOOL Enable Input System Defi EnableOut BOOL Enable Output System De Stop BOOL Enter the tag that gives the Start BOOL Enter the tag that gives the Jog BOOL Jog command for the motor AuxContact BOOL Auxiliary contact of the mot ClearFault BOOL To clear the fault of the mo Out BOOL Output command to the mo Faut 0 BOOL If on the motor didn t start FaultTime VES my INT Enter the time ms to wait f Ossooossoco C Sort Parameters nsert Instruction Default Insert Definition Defaults Save Instruction Defaults Cok _cancet J aow C Heo 2 Monitor the value of the parameters and change any if needed 3 Type a new value for each parameter as needed 4 Click Apply and when finished OK 78 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 3 Viewing Logic and Monitor with Data Context Follow this procedure when you want to view the logic of an Add On Instruction and monitor data values with the l
36. History Help instruction type Enableln Input BOOL El Enable Input EnableOut Output BOOL ee El Enable Outpu Stop Input BOOL 5 Decimal v Start Input BOOL 5 Decimal v BOOL 5 Decimal Jog Input AuxContact Input BOOL 9 Decimal BOOL 5 Decimal ClearFault Input Dut Output BOOL 0 Decimal Fault BOOL 0 Decimal Output 5 Decimal FaultTime Input DINT Enter the tag Enter the tag Jog command Auziliary cont To clear the f Output comm If on the mot Enter the time Read Only Read Only Read Write Read Write Read Write Read Write Read Write Read Only Read Only Read Write sre ese at Typs a Fol et S Bel vis Desertor Exenat assess Corset __ 00000000000 of paramete Copy all default value Data Type Size 20 byte s Rockwell Automation Publication 1756 PM010E EN P September 2012 Figure 6 Motor Starter Example Ladder Logic Chapter 2 when you press open the Stop button The run command turns off if there is a fault If on the motor didnt start or stop Fault Start command for the motor Start Stop command tor the motor Data Contest S Motor_Starter lt definition gt Se if the Stop button is closed the motor gets the command to run when you press the Start button The motor runs even after you release the Sta
37. No Execute Postscan No Execute Enable In False No Software Revision v17 00 Additional Help Text Use this instruction to start and st Logic is different Current Operation Overwrite Overwrite Use Existing Rockwell Automation Publication 1756 PM010E EN P September 2012 1 0 Rockwell 10 24 2005 6 50 43 PM NA Mills 5 20 2009 9 15 59 PM NA srdennis No No No v16 03 Use this instruction to start a 91 Chapter 4 92 TIP The Compare dialog box only compares extended properties for each instruction definition such as description revision or edited date For effective revision control enter a detailed revision note The Project References tab shows where the existing Add On Instruction is used Add On Instruction Name Collision Conveyor_Control Property Compare Project References Locations where Conveyor_Control is called in project Selected call s arguments Container Routine Location Parameter Argument Motor_Starte Nested_Moto Rung 1 Stop Conveyor_1_Jamcl Start Conveyor_1_Entry_PE Out Jam lt Unknown gt Conveyor_1_Out C Show Changed Parameters Only A Tf existing instruction is overwritten once import completes check all locations calling Conveyor_Control to ensure they will execute correctly with the updates Current Operation Overwrite IMPORTANT Check each routine where your Add On Instruction is used to make sure that your existing pr
38. Programming Manual Allen Bradley Logix5000 Controllers Add On Instructions Catalog Numbers 1756 ControlLogix 1756 GuardLogix 1768 CompactLogix 1768 Compact GuardLogix 1769 CompactLogix 1789 SoftLogix PowerFlex with DriveLogix a p ait uit i Allen Bradley Rockwell Software Automation Important User Information Solid state equipment has operational characteristics differing from those of electromechanical equipment Safety Guidelines for the Application Installation and Maintenance of Solid State Controls publication SGI 1 1 available from your local Rockwell Automation sales office or online at http www rockwellautomation com literature describes some important differences between solid state equipment and hard wired electromechanical devices Because of this difference and also because of the wide variety of uses for solid state equipment all persons responsible for applying this equipment must satisfy themselves that each intended application of this equipment is acceptable 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
39. Sys Read Only EnableOut Output Enable Output Read Only Fault Output If on the motor di Read Only FaultT ime Input Enter the time ms Read Write FaultTimer Local Read write Jog Input Jog command for t Read Write Decimal Decimal Decimal Decimal Decimal salpadoig Li Decimal Decimal Decimal Out Output Output command t Read Only Decimal RunCommand Local Read Write Decimal ail Start Input Enter the tag that Read Write Stop Input Enter the tag that Read Write Decimal Decimal OAH OOOO R0 00000 Monitor Tags Edit Tags a Updates to Arguments If you edit an Add On Instruction by adding deleting renaming reordering or changing the status or usage type of one or more parameters RSLogix 5000 Following Parameter Edits software version 18 and later automatically updates the arguments on calls to the instruction Source protected routines and other source protected Add On Instructions that use the edited Add On Instruction are not automatically updated if the source key is unavailable The Add On Instruction or routine may still verify but the resulting operation may not be as intended It is your responsibility to know where Add On Instructions are used in logic when you make edits to existing Add On Instructions Rockwell Automation Publication 1756 PM010E EN P September 2012 41 Chapter 2 A confirmation dialog box shows you the impacts of the edits and
40. This information is gathered from the definition gociwen descrip tions tha t you comple te when de fi ning Contact the Add On Instruction developer for questions or problems with this instruction instruction Starts and stops a motor Available Languages Relay Ladder EE amp Add On Instruction Definition Motor_Starter v1 0 General Parameters Local Tags Scan Modes Signature a Motor_Starter aa ee a aoe Starts and stops a motor Name artei Motor_Starter Stop Description Starts and stops a motor Start T Out 2 Type Ebb Ladder Diagram Major Minor Extended Tent Revision 1 o F 23 Function Block Revision Note Motor_Starter j Starts and stops a motor 1G Stop Out Start Fault Vendor R I iua Structured Text r enie Motor_Starter Motor Starter Stop Start Out Add On Instruction Definition Motor_Starter v1 0 t Bi l Parameters General Local Tags Scan Modes Signature Change History Help Parameters Ge Description __ Evternal Access Required Name Data Type Usage Description Erabi Ipu B00 1 Decima C E Enable re teal o x Motor_Starter Motor_Starter InOut Enable lut Output BOOL 0 Decimal C Enable Dutpu Read Only o a Stop Input BOOL O Decimal Z Z Enter the tag Read wiite D a BOOL Input Stat Input BOOL OfDecimal Z lEnterth
41. Values are passed out of Output parameters from their arguments in the instruction call If the EnableInFalse routine is not enabled the only action performed for the Add On Instruction in the false condition is that the values are passed to any required Input parameters in ladder logic Follow these steps to create an EnableInFalse routine 1 Right click the instruction and choose Open Definition 2 Click the Scan Modes tab 3 Click New on EnableInFalse routine amp Add On Instruction Definition Simulation_DT_1st General Parameters Local Tags Scan Modes Signature Change History Help The controller prescans and postscans the Add On Instruction Logic routine but will not execute the Logic routine when Enableln is false Optional Prescan Postscan and EnablelnFalse routines may be configured below Prescan routine Executes prior to first scan on transition from program to run New Pastscan routine Executes on last scan of a step if SFC is configured for automatic reset New EnablelnFalse routine Executes when the Enableln parameter is false Data Type Size 276 byte s _ Cancel 50 Rockwell Automation Publication 1756 PM010E EN P September 2012 Using the Enableln and EnableOut Parameters Chapter 2 4 From the Type menu on the New Scan Mode Routine dialog box choose the type of programming language Ladder Function Block or Structured Text New Scan Mode Routine Mode E
42. ach Add On Instruction has its own instruction signature on the Add On Instruction definition The instruction signature is required when an Add On Instruction is used in SIL 3 safety related functions and may be required for regulated industries Use it when your application calls for a higher level of integrity Once generated the instruction signature seals the Add On Instruction preventing it from being edited until the signature is removed This includes rung comments tag descriptions and any instruction documentation that was created When an instruction is sealed you can perform only these actions Copy the instruction signature Create or copy a signature history entry Create instances of the Add On Instruction Download the instruction Remove the instruction signature Print reports The instruction signature does not prevent referenced Add On Instructions or User defined Data Types from being modified Changes to the parameters of a referenced Add On Instruction or to the members of a referenced User defined Data Type can cause the instruction signature to become invalid These changes include Adding deleting or moving parameters local tags or members in referenced User defined Data Types Changing the name data type or display style of parameters local tags or members in referenced User defined Data Types If you want to enable project documentation or source protection on an Add On Instruction that will be sea
43. ags Scan Modes Signature Change History Help Extended Description Text Use this instruction to start and stop a motor The instruction uses a basic stop and start circuit If the Stop button is closed the motor gets the command to run when you press the Start button The motor runs even after you release the Start button The motor stops when you press open the Stop button Use the Jog bit to jog the motor The Jog bit overrides the Stop button Instruction Help Preview Extended Description Use this instruction to start and stop a motor The instruction uses a basic stop and start circuit Ifthe Stop button is closed the motor gets the command to run when you press the Start button The motor runs even after you release the Start button The motor stops when you press open the Stop button Use the Jog bit to jog the motor The Jog bit overrides the Stop button You can also use the auxiliary contact of the motor to make a fault happen if the motor doesn t start or stop Copy all default values of para and local tags whose values were modified to all tags of this instruction type Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Documenting an Add On Instruction Follow these steps to create custom help for an instruction Right click an Add On Instruction and choose Open Definition On the General tab enter a description and a revision note for the Add O
44. arameters and Local Tags 41 Updates to Arguments Following Parameter Edits 41 Copying Parameter or Local Tag Default Values 43 Creating Logic for the Add On Instruction 44 Defining Operation in Different Scan Modes 45 Enabling Scan Modes 46 Using the Enableln and EnableOut Parameters 51 Changing the Class of an Add On Instruction 53 Testing the Add On Instruction 53 Defining Source Protection for an Add On Instruction 55 Generating an Add On Instruction Signature 56 Creating Instruction Help 59 Motor Starter Instruction Example 64 Simulation Instruction Example 6 Follow these steps to create a new Add On Instruction 1 Open a new or existing project 2 Right click the Add On Instructions folder in the Controller Organizer and choose New Add On Instruction 35 Chapter 2 3 Type a unique name for the new instruction The name can be up to 40 characters long It must start with a letter or underscore and must contain only letters numbers or underscores The name must not match the name of a built in instruction or an existing Add On Instruction New Add On Instruction Name Motor_Starter Description Starts and stops a motor Type By Ladder Diagram Major Minor Extended Text Revision Revision Note Vendor Rockwell C Open Logic Routine Open Definition 4 Type a description for the new instruction maximum 512 characters 5 For safety projects choose a class either Standard o
45. aultTime starts Otherwise this 1f on the motor If off the motor input doesnt do didnt start or stops anything stop Out AuxContact FautTimer DN Faut sl JE 4 To clear the fault of the motor turn on the FaultClear bit To clear the fault If on the motor of the motor turn didnt start or on this bit stop ClearFautt Faut 4 JE D End The following diagrams show the Motor Starter instruction called in three different programming languages Figure 7 Motor Starter Ladder Diagram Conveyor lotor_ Starter Starts and stops a motor Motor_Starter Stop Start Out Rockwell Automation Publication 1756 PM010E EN P September 2012 Motor_Starter_LD Stop_PB oe Start_PB 0e Motor_Out_LD oe F3 65 Chapter 2 Figure 8 Motor Starter Function Block Diagram Conveyor Pushbutton to stop the conveyor Motor Starter FBD 0 Sto p_PB a Motor Starter Starts andstopsa motor Output command tothe conveyor motor mE MotorO ut_F BD Pushbutton to start the conte yor 0 Stat PB 9 H Figure 9 Motor Starter Structured Text Motor_Starter Motor_Starter_ST Stop_PB Start_PB Motor_Out_ST Simulation Instruction Example The Simulation _ DT_1st Add On Instruction adds a dead time and a first order lag to an input variable Figure 10 Simulation Example Definition Editor General Tab
46. ccess local tag values from an HMI by specifying the name of the local tag as amember in an Add On Instruction type tag For example the Motor_Starter v1 0 instruction shown in step 2 has a tag called CheckAuxContact This tag can be referenced by an HMI via instancetag CheckAuxContact where instancetag is the tag used to call the instruction Follow these steps to define the local tags for your instruction 1 In the Controller Organizer right click an instruction and choose Open Definition Rockwell Automation Publication 1756 PM010E EN P September 2012 39 Chapter 2 2 Click the Local Tags tab and type a name for a new tag and select a data type Add On Instruction Definition Motor_Starter v1 0 General Parameters Local Tags Scan Modes Signature Change History Help CheckAusCont BOOL 0 Decimal _ F FautTimer TIMER RunCommand BOOL 0 Decimal Name 8 4 Data Type Default Style Description 2 You cannot use these data types for local tags ALARM_ANALOG ALARM_DIGITAL MESSAGE or any Motion data types for example Axis or MOTION_GROUP To use these type of tags in your Add On Instruction define an InOut Parameter Local tags also are limited to single dimension arrays the same as User Defined Data Types TIP Refer to the GuardLogix Controller Systems Safety Reference Manual publication 1756 RM093 for a list of data types supported for safety instructions 3 Set the de
47. e a description of the Prescan behavior 6 Click OK to create the routine and return to the Scan Modes tab 7 Define if the prescan routine executes or not by checking or clearing Execute Prescan routine after the logic routine is prescanned m Prescan routine Executes prior to first scan on transition from program to run Execute Prescan routine after the Logic routine is prescanned The Prescan routine can now be edited like any other routine Postscan Routine Postscan mode occurs only for logic in a Sequential Function Chart Action when the Action becomes inactive and the SFC language is configured for Automatic Reset which is not the default option for SFC When an SFC Action becomes inactive then the logic in the Action is executed one more time in Postscan mode This mode is similar to Prescan in that most instructions simply execute as if they have a false condition It is possible for an instruction to have different behavior during Postscan mode than it has during Prescan mode When an Add On Instruction is called by logic in an SFC Action or a call resides in a routine called by a JSR from an SFC Action and the Automatic Reset option is set the Add On Instruction executes in Postscan mode The primary logic routine of the Add On Instruction executes in Postscan mode Then if it is defined and enabled the Postscan routine for the Add On Instruction executes This could be useful in resetting internal states status values
48. e instruction is by defining an alias parameter See Creating an Alias Parameter for a Local Tag on page 28 Add On Instruction Definition Simulation_DT_1st v1 0 Sim General Parameters Local Tags Scan Modes Signature Change History Help _ Name al Data Type Defaut__ Style Description SC veot_o DEADTIME Tak LDLG_01 LEAD_LAG were modified to all tags of this instruction type Data Type Size 276 byte s Apply Her 14 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Data Type Parameters and local tags are used to define the data type that is used when executing the instruction The software builds the associated data type The software orders the members of the data type that correspond to the parameters in the order that the parameters are defined Local tags are added as hidden members The data type for a Local Tag may not be a multi dimensional array or an object type which includes all Motion types MSG ALARM_ANALOG and ALARM_DIGITAL The data type field is unavailable for members of a Local Tag Logic Routine The logic routine of the Add On Instruction defines the primary functionality of the instruction It is the code that executes whenever the instruction is called Shown below is the interface of an Add On Instruction and its primary logic routine that defines what the instruction does Level Loop 101
49. efined Data Types and any User Defined Data Types that reference them Then import the lowest level Add On Instructions followed by any Add On Instructions that reference those low level Add On Instructions Once all of the items it references are in place the import of the Add On Instruction will succeed Exporting to a Single File Ifyou manage each Add On Instruction as a standalone you may want to export the instruction and any referenced Add On Instructions or User Defined Data Types into one export file By including any referenced Add On Instructions or User Defined Data Types you also make it easier to preserve the instruction signature of an Add On Instruction Follow these steps to export to a single file and include any referenced items 1 Right click Add On Instruction in Controller Organizer and choose Export Add On Instruction 2 Choose the location to store the L5X file Save in aor Projects x aa My Recent Documents E Desktop Add On Instructions CantopenEngrelease Oldnotneededquestionmark lt 2 Example_Export_Conveyor_Control L5 2 Motor _Starter L5X i My Documents Fr My Computer b e File name Conveyor Control OLET Save as type RSLogix 5000 XML File L5 x Cancel Places IV Include all referenced Add On Instructions and User Defined Types Help Zi 3 Type a name for the file 4 Check Include referenced Add On Instructions and User Defined Types
50. eln parameter is set True False The instruction is scanned as the result of a false rung condition or the Enableln parameter is set False Instructions in the controller may or may not have logic that executes only when that instruction is scanned false Prescan Occurs when the controller either powers up in Run mode or transitions from Program to Run Instructions in the controller may or may not have logic that executes only when that instruction is executed in Prescan mode Postscan Occurs as a result of an Action in an Sequential Function Chart SFC routine becoming inactive if SFCs are configured for Automatic Reset Instructions in the controller may or may not have logic that executes only when that instruction is executed in Postscan mode 1 Postscan mode routines cannot be created for safety Add On Instructions because safety instructions do not support SFC Rockwell Automation Publication 1756 PM010E EN P September 2012 45 Chapter 2 Enabling Scan Modes 46 The default behavior for executing an Add On Instruction with no optional scan routines created may be sufficient for the intended operation of the instruction If you do not define an optional Scan Mode the following default behavior of an Add On Instruction occurs Scan Mode Result True Executes the main logic routine of the Add On Instruction False Does not execute any logic for the Add On Instruction and does not write any outputs Input pa
51. entries can be stored Ifa seventh entry is made the oldest entry is automatically deleted Change History The Change History tab displays the creation and latest edit information that is tracked by the software The By fields show who made the change based on the Windows user name at the time of the change Add On Instruction Definition Simulation_DT_ st General Parameters Local Tags Scan Modes Signature Change History Help Created 10 5 2005 2 56 13 PM By NASmilted Edited 6 22 2009 1 04 18 PM By NA sellnid Data Type Size 276 byte s Rockwell Automation Publication 1756 PM010E EN P September 2012 17 Chapter 1 Considerations for Add On Instructions 18 Help The name revision description and parameter definitions are used to automatically build the Instruction Help Use the Extended Description Text to provide additional Help documentation for the Add On Instruction This content reflects updates as Parameters or other attributes are changed in the definition The Instruction Help Preview shows how your instruction will appear in the various languages based on parameters defined as required or visible Add On Instruction Definition Simulation_DT_ 1st General Parameters Local Tags Scan Modes Signature Change History Help Extended Description Text Instruction Help Preview Simulation_DT_1st v1 0 Sim DT 1st Rockwell Automation Contact
52. ested_Motc Rung 2 EnableOut OutCommand SimulateF ault t Local Tag 8 4 Default DelayTimer H DelayTimer PRE 0 E DelayTimer ACC H DelayT imer EN H DelayT imer TT DelayT imer DN 0 0 0 0 a Check the boxes to select which values to copy to which tags and click OK Creating Logic for the Follow these steps to enter logic into your project Add On Instruction 1 In the Controller Organizer expand the Add On Instructions folder Add On Instructions Conveyor_Control Motor_Starter Simulate _Feedback Simulation_DT_1st BS 2 Expand the instruction and double click the logic routine to open Motor _Starter Parameters and Local Tags Ea Logic Ba EnableInFalse 3 Edit your logic by using the available language editors Execution Considerations for Add On Instructions An Add On Instruction is executed just like any other routine belonging to a particular program Because another task can preempt a program containing an Add On Instruction that is being executed an Add On Instruction may be interrupted prior to completing its execution 44 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Defining Operation in Different Scan Modes In standard programs you can use the User Interrupt Disable Enable UID UIE instructions to block a task switch if you want to be sure the Add On Instruct
53. etag Readwite O 1 EnableOut BOOL Output Jog Input BOOL T Decimal C C Jog command Read Wite iian x Stop BOOL Input Enter the tag that gives the stop command for the motor AuxContact Input BOOL O Decimal C C Aunia cont Read wiite o x Start BOOL Input Enter the tag that gives the start command for the motor CleaFaut Input BOOL T Decimal C E To clear thet Read wite o Jog BOOL Input Jog command for the motor Out Output BOOL T Decimal ic Output comm Read Only o To jog the motor turn on this bit Faut Output BOOL O Decimal C Z If on the mot Read Only jea To stop the jog turn off this bit E FautTime Input DINT Decimal C C Erterthe time Read wite mami AuxContact BOOL Input Auxiliary contact of the motor DO Oo Make sure you set the FaultTime Otherwise this input doesn t do anything ClearFault BOOL Input To clear the fault of the motor turn on this bit x Out BOOL Output Output command to the motor starter If on the motor starts If off the motor stops Fault BOOL Output If on the motor didn t start or stop FaultTime DINT Input Enter the time ms to wait for the auxiliary contact to open or close The Fault bit turns on when that time is up Add On Instruction Definition Motor_Starter v1 0 General Parameters Local Tags Scan Modes Signature Change History Help Signature Generate a signature to uniquely identify this instruction and seal it from modifications Extended
54. eters All InOut parameters are required TIP When you are using your Add On Instructions the Visible setting may be overridden in Function Block Diagram routines if the parameter is not required or already wired Overriding the visibility at the instruction call does not affect this definition configuration Using Standard and Safety Tags When creating a safety Add On Instruction follow these guidelines for standard and safety tags Standard tags may not be used as Input Output or InOut parameters of a safety Add On Instruction Safety tags may be used as Input parameters for standard Add On Instructions Data Access Control In RSLogix 5000 software version 18 and later you can prevent programmatic modification of InOut parameters by designating them as constants You can also configure the type of access you will allow external devices such as an HMI to have to your tag and parameter data You can control access to tag data changes with the Logix Designer application by configuring FactoryTalk security Rockwell Automation Publication 1756 PM010E EN P September 2012 Constant Values Chapter 1 InOut parameters may be designated as constant value tags to prevent their data from being modified by controller logic If the logic of an Add On Instruction contains a write operation to a constant value parameter the Add On Instruction will not verify in the Add On Instruction definition context Add On Instruction Param
55. eters and Local Tags SafetyAddOnInstruction Scope SatetyAddOnInstruction Show All Tags 8 4 Usage Alias For Safety Safety Safety 4 gt Monitor Tags Edit Tags C External Access Extemal Access DEA Enable Input Sys Read Only Enable Output Read Only saipadoig i External Access defines the level of access that is allowed for external devices such as an HMI to see or modify tag values Add On Instruction Parameters and Tags External Access Options Local tag Read Write Input parameter Read Only Output parameter None Enablel t nableln parameter Read Only EnableOut parameter InOut parameter N A Add On Instruction Parameters and Local Tags Simulate_Feedback E Scope Ag Simulate_Feedback Show All Tags zaf Usage Alias For m DelayTime DelayT imer Enableln EnableDut OutCommand SimulateF ault 4 gt Monitor Tags Edit Tags lt Description External Access Constant Style a Enter the time in m Read Write a Decimal Read write Enable Input Sys Read Only Decimal Enable Output Read Only Decimal Enter the tag for t Read write Decimal To simulate a fault Read Write v Decimal Read Write Read Only None saipadoig Lig Rockwell Automation Publication 1756 PM010E EN P September 2012 31 Chapter 1 Planning Your Add On Instruction Design 32 Take time
56. ety Add On Instruction copy 82 import 88 safety application instructions restrictions 25 safety instruction signature 16 21 copy 57 create 58 delete 58 invalid 58 view 59 safety task signature 19 53 82 88 additional resources 8 Scan Mode tab 16 scan modes 45 51 planning 34 verify 55 Scan Modes tab 46 SFC Action 48 signature history 17 57 Signature tab 16 SIL 3 21 source protection applying 56 enabling 56 instruction signature 20 options 56 planning 32 Quick View pane 81 SSV 26 standard dass 13 tags 30 store your instructions 82 Structured Text instruction example 74 T tags create local tags 39 standard and safety 30 test 53 planning 34 transitional instructions 21 translation See language switching Rockwell Automation Publication 1756 PM010E EN P September 2012 U V unavailable instructions 24 visible update Add On Instruction revision 90 parameters 29 30 Rockwell Automation Publication 1756 PM010E EN P September 2012 95 96 Rockwell Automation Publication 1756 PM010E EN P September 2012 Rockwell Automation Support Rockwell Automation provides technical information on the Web to assist you in using its products At http www rockwellautomation com support you can find technical manuals a knowledge base of FAQs technical and application notes sample code and links to software service packs and a MySupport feature that you can customize to make the best use of these tool
57. fault values Default values are loaded from the Add On Instruction definition into the tag of the Add On Instruction data type when it is created or any time a new tag is added to the Add On Instruction TIP Check the box at the bottom of the Add On Instruction Definition Editor to Copy all default values of parameters and local tags whose values were modified to all tags of this instruction type if you want to update existing invocations of the instruction to the new default values For details on copying default values see Copying Parameter or Local Tag Default Values on page 43 4 Set the display style 5 Type a description a maximum of 512 characters 6 Repeat for additional local tags TIP When you create a local tag from the Local Tags tab the External Access setting defaults to None You can edit the External Access setting by using the Tag Editor See Editing Parameters and Local Tags on page 41 40 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Editing Parameters and You can also add and edit parameters and local tags on the Edit Tags tab shown Local Tags om Add On Instruction Parameters and Local Tags Motor_Starter Scope Ej Motor_Starter Show All Tags 2l BI 4 Usage Description External Access Constant Ausiliary contact o Read Write E Check uxContact Read write ClearF ault To clear the fault Read write Enableln Enable Input
58. ference For most instructions Prescan mode is synonymous with scanning false For example an OTE instruction clears its output bit when executed during Prescan mode For others special initialization may be done such as an ONS instruction setting its storage bit during Prescan mode During Prescan mode all instructions evaluate false so conditional logic does not execute The optional Prescan routine for an Add On Instruction provides a way for an Add On Instruction to define additional behavior for Prescan mode When a Prescan routine is defined and enabled the Prescan routine executes normally after the primary logic routine executes in Prescan mode This is useful when you want to initialize tag values to some known or predefined state prior to execution Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 An example would be setting a PID instruction to Manual mode with a 0 output prior to its first execution or initializing some coefficient values in your Add On Instruction When an Add On Instruction executes in Prescan mode any required parameters have their data passed Values are passed to Input parameters from their arguments in the instruction call Values are passed out of Output parameters to their arguments defined in the instruction call These values are passed even when the rung condition is false in Ladder Diagram or when the instruction call is in a false conditional statement
59. for the device turn on this bit feedback to turn on OutCommand SimulateFautt EQ Ov Data Context Motor_1_AuxContact Motor_Starter_Prograr ul 0 Grtr Than or Eql 4 gt B Move DelayTime Source DelayTime 2000 2000 Source B 0 Dest DelayTimer PRE 2000 TON Timer On Delay EN Timer DelayTimer Preset 2000 DN3 Accum 0 Enable Output System Defined Parameter DelayTimer DN EnableOut 1 Ss XI SS S SS aaa 80 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 3 Determining if the Add On Instruction is Source Protected To edit the logic of the Add On Instruction you must select the instruction lt definition gt in Data Context Data Context Motor_Starter lt definition gt You cannot edit the instruction logic Online When the logic is in the context of an instruction call Ifthe instruction is source protected Ifthe instruction is sealed with an instruction signature An Add On Instruction may be source protected so you cannot view the logic Follow these steps to see if an Add On Instruction is source protected 1 Select the Add On Instruction in the Controller Organizer The Add On Instruction cannot be expanded when fully protected 2 Look in the Quick View pane for Source Protection If the Source Protection attribute is not listed then the instruction is not protected Add On Instructions Con
60. functionality by nesting instructions The instructions can be nested to seven levels deep Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Add On Instructions cannot call other routines via a JSR instruction You must use nested instructions if you need complex functionality consisting of multiple routines TIP To nest Add On Instructions both the nested instruction and the instruction that calls it must be of the same class type or the calling instruction will not verify That is standard Add On Instructions may call only standard Add On Instructions and safety Add On Instructions may call only safety Add On Instructions Routines Versus Add On Instructions You can write your code in three basic ways to run in line as a main routine to use subroutine calls or as Add On Instructions The following table summarizes the advantages and disadvantages of each Table 1 Advantages and Disadvantages of Routines and Add On Instructions Aspect Main Routine Subroutine Add On Instruction Accessibility N A Within program multiple copies one foreach Anywhere in controller single copy for the entire project program Parameters N A Pass by value Pass by value via Input and Output parameters or by reference via InOut parameters Numeric parameters N A No conversion user must manage Automatic data type conversion for Input and Output parameters Parameters data types N A Atomic arrays structures
61. ge indicates that the signature is invalid You must remove the instruction signature review the Add On Instruction and generate a new instruction signature Creating a Signature History Entry The signature history provides a record of signatures for future reference A signature history entry consists of the name of the user the instruction signature the timestamp value and a user defined description You can only create a signature history if an instruction signature exists and you are offline Creating a signature history changes the Last Edited Date which becomes the timestamp shown in the history entry Up to six history entries may be stored Follow these steps to create a signature history entry 1 On the Signature tab of the Add On Instruction Definition Editor click Add to History 2 Type a description up to 512 characters long for the entry 3 Click OK TIP To facilitate record keeping you can copy the entire signature history to the clipboard by selecting all the rows in the signature history and choosing Copy from the Edit menu The data is copied in tab separated value TSV format To delete the signature history click Clear Signature History while the instruction does not have an instruction signature You must be offline to delete the Signature History Rockwell Automation Publication 1756 PM010E EN P September 2012 57 Chapter 2 58 Generating a Safety Instruction Signature When a sealed
62. in Structured Text When Function Block Diagram routines execute the data values are copied to all wired inputs and from all wired outputs whether or not the parameters are required Follow these steps to create a Prescan routine 1 In the Controller Organizer right click an instruction and choose Open Definition 2 Click the Scan Modes tab 3 Click New for Prescan Routine Add On Instruction Definition Simulation_DT_1st n General Parameters Local Tags Scan Modes Signature Change History Help The controller prescans and postscans the Add On Instruction Logic routine but will not execute the Logic routine when Enableln is false Optional Prescan Postscan and EnablelnFalse routines may be configured below Prescan routine Executes prior to first scan on transition from program to run New Postscan routine Executes on last scan of a step if SFC is configured for automatic reset New EnablelnFalse routine Executes when the Enableln parameter is false Data Type Size 276 byte s Rockwell Automation Publication 1756 PM010E EN P September 2012 47 Chapter 2 4 From the Type menu on the New Scan Mode Routine dialog box choose the type of programming language Ladder Diagram Function Block or Structured Text New Scan Mode Routine Mode Prescan OK Description Type Ba Function Block Diagram Instruction Simulation_DT_1st C Open Routine 5 Typ
63. input T SimTimeConstant FT SimOutput DAA Parameter With Description Single question mark This is a required InOut parameter Enter a tag Single and double question marks This is a required Input or Output parameter Enter a tag Double question marks This is not a required parameter You can either Leave as is and use the default value Enter a different value if it is an Input parameter Function Block Diagram Nub al x Sim ulation_D T_1st Simulation instruction which includes a SimDTinv H Item Description Nub on the end of pin This is a required Input or Output parameter You must wire the pin to an IREF OREF connector or another block to verify Single question mark This is a required InOut parameter Enter a tag No nub on the end of pin This is not a required parameter You can either Leave as is and use the default value Enter a different value if it s an Input parameter Structured Text n instruction which includes a Simulation_DT_1st Simulation_DT_1st Simlnput DA1 74 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 3 The instruction expects arguments for required parameters as listed in the instruction tooltip TIP For help with an instruction select the instruction and then press F1 In Structured Text make sure the cursor is in the blue instruction name Tips for Using an Add On This table describes programming tips for
64. input pin can force it to be False 0 Enableln Parameter and Structured Text In the Structured Text environment the EnableIn parameter is always set True 1 by default The user cannot influence the state of the EnableIn parameter in a Structured Text call to the instruction Because EnableIn is always True 1 in Structured Text the EnableInFalse routine will never execute for an instruction call in Structured Text Rockwell Automation Publication 1756 PM010E EN P September 2012 Changing the Class of an Add On Instruction Testing the Add On Instruction Chapter 2 You can change the class of a safety Add On Instruction so that it can be used in a standard task or standard controller You can change the class in a safety project if the instruction does not have an instruction signature you are offline the application does not have a safety task signature and is not safety locked You can also change the class from standard to safety so that the Add On Instruction can be used in the safety task Changing the class of an Add On Instruction results in the same class change being applied to the routines parameters and local tags of the Add On Instruction The change does not affect nested Add On Instructions or existing instances of the Add On Instruction If any parameters or tags become unverified due to the change of class they are identified on the Parameters and Local Tags tabs of the Add On Instruction Editor If an
65. interaction outside of the Add On Instruction itself Rockwell Automation Publication 1756 PM010E EN P September 2012 9 Preface 10 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Introduction About Add On Instructions Designing Add On Instructions Add On Instructions are available beginning with RSLogix 5000 software version 16 Add On Instructions are custom instructions that you design and create Beginning in RS Logix 5000 software version 18 high integrity and safety Add On Instructions are available Topic Page About Add On Instructions 11 Components of an Add On Instruction 13 Considerations for Add On Instructions 18 Considerations When Creating Parameters 27 Planning Your Add On Instruction Design 32 With Add On Instructions you can create new instructions for sets of commonly used logic provide a common interface to this logic and provide documentation for the instruction Add On Instructions are intended to be used to encapsulate commonly used functions or device control They are not intended to be a high level hierarchical design tool Programs with routines are better suited to contain code for the area or unit levels of your application These are some benefits to using Add On Instructions e Reuse code You can use Add On Instructions to promote consistency between projects by reusing commonly used control algorithms If
66. io 5000 Create Open Explore New Project Existing Project Help _ From Import Sample Project Release Notes From Sample Project From Upload About Recent Projects B Seri Test intecrates_Motion_Co B Aunus 2012 The Studio 5000 environment is the foundation for the future of Rockwell Automation engineering design tools and capabilities It is the one place for design engineers to develop all the elements of their control system This manual shows how to design configure and program Add On Instructions This manual is one of a set of related manuals that show common procedures for programming and operating Logix5000 controllers For a complete list of common procedures manuals see the LogixS000 Controllers Common Procedures Programming Manual publication 1756 PMO001 The term Logix5000 controller refers to any controller that is based on the Logix5000 operating system including the following e CompactLogix and Compact GuardLogix controllers e ControlLogix and GuardLogix controllers e DriveLogix controllers e FlexLogix controllers e SoftLogix5800 controllers With the addition of safety Add On Instructions in RSLogix 5000 software version 18 you can use Add On Instructions in GuardLogix and Compact GuardLogix safety related functions This manual provides information about safety Add On Instructions Rockwell Automation Publication 1756 PM010E EN P September 2012 7 Preface For detailed informati
67. ion contained in a Structured Text routine since Enableln is always true for calls in Structured Text Instruction Size Add On Instructions have one primary logic routine that defines the behavior of the instruction when executed This logic routine is like any other routine in the project and has no additional restrictions in length The total number of Input parameters plus Output parameters plus local tags can be up to 512 There are no limits on the number of InOut parameters However limit extended properties Min and Max syntax should not be defined on an InOut parameter of an Add On Instruction and should not be used in Add On Instruction definition logic or the logic does not verify Limits cannot be accessed inside Add On Instruction logic The maximum data instance supported which includes Inputs Outputs and local tags is two megabytes The data type size is displayed on the bottom of the Parameters and Local Tags tab in the Add On Instruction Definition J Logic Data Type Size 276 byte s Runtime Editing Add On Instructions can only be edited offline If the intended functionality needs to be changed in a running controller consider carefully ifan Add On Instruction is suitable Nesting Add On Instructions Add On Instructions can call other Add On Instructions in their routines This provides the ability to design more modular code by creating simpler instructions that can be used to build more complex
68. ion executes uninterrupted before switching to another task TIP UID and UIE instructions are not supported in the safety task of GuardLogix projects Optimizing Performance The performance depends on the structuring configuration and the amount of code in an Add On Instruction You can pass large amounts of data through a structure by using an InOut parameter The size of data referenced by an InOut parameter does not impact scan time and there is no difference between passing a user defined type tag or an atomic tag because it is passed by reference When a rung condition is false any calls to an Add On Instruction are still processed even though the logic routine is not executed The scan time can be affected when many instances of an Add On Instruction are executed false Be sure to provide instructions in your documentation if an Add On Instruction can be skipped when the rung condition is false To provide Add On Instructions with the same flexibility as built in instructions optional Scan mode routines can be configured to fully define the behavior of the instruction Scan mode routines do not initially exist for Add On Instructions You can create them depending upon the requirements of your instruction Like all built in instructions in the controller Add On Instructions support the following four controller Scan modes Scan Mode Description True The instruction is scanned as the result of a true rung condition or the Enabl
69. ions for Add On Instructions 000c cece eee eee Instruction Functionality cisscced otra caw egen rererere Encapsilation cic chevoe dn iceder id coude A A dee Safety Add On Instructions 2 0 54424 sh seeded is te TLHSETUCHON SIGMALUEE 35 0 shorn eie orreri a a Wu Raw e eraa Safety Instruction oighatubes 2 2 eu lt uckadinat Medete tage cael Programming Languages 52 45 s 05 dst goon et oie Sakae Transitional Instructions 224 hsde eee dena cieisal ebeteanve IAStruction Size ai acute E A A E O A daa Ranting Editing sves ne Viottd rut uniene as oath audi E E AE Nesting Add On Instructions 0 0 0 0 cece cece e eee eee eee Routines Versus Add On Instructions 000ceee eee eees Programmatic Access to Datars dition ith erties anaes tlre Unavailable Instructions within Add On Instructions Using GSV and SSV Instttictions 2 0asias dos nvasuseebiwwokars Considerations When Creating Parameters 0 00000 ceca ee Passing Arguments to Parameters by Reference or by Value Selecting a Data Type for a Paratneter cisse scadidsdcsaeeecne te Creating an Alias Parameter for a Local Tag ccccenseswonvenees Using a Single Dimension Array as an InOut Parameter Determining Which Parameters to Make Visible or Required Using Standard and Safety Tags saccsnaeh oe ban ustles scavernme Data Access Contra utiwcmi ie eased Saunt eee ta had Planning Your Add On Instruction Design
70. is enabled the EnableInFalse routine will be executed Rockwell Automation Publication 1756 PM010E EN P September 2012 51 Chapter 2 52 Enableln Parameter and Ladder Diagram In the ladder diagram environment the EnableIn parameter reflects the rung state on entry to the instruction If the rung state preceding the instruction is True 1 the EnableIn parameter will be True and the primary logic routine of the instruction will be executed Likewise if the rung state preceding the instruction is False 0 the EnableIn parameter will be False and the primary logic routine will not be executed TIP An instruction with only Input parameters except EnableOut is treated as an input instruction left justified in a Ladder Diagram The EnableOut parameter is used for the rung out condition Enableln Parameter and Function Blocks In the function block environment the EnableIn parameter can be manipulated by the user through its pin connection If no connection is made the EnableIn parameter is set True 1 when the instruction begins to execute and the primary logic routine of the instruction will be executed Ifa wired connection to this parameter is False 0 the primary logic routine of the instruction will not execute Another reference writing to the EnableIn parameter such as a Ladder Diagram rung ora Structured Text assignment will have no influence on the state of this parameter Only a wired connection to this parameter s
71. is flagged w Conveyor_Control already exists in a project and is different Existing references to the instruction type may be affected including Revision i logic that calls instruction tags of this instruction type Revision Note add on instructions and user Vendor Rockwell Conveyor_Control already exists in project and is different Existing references may be affected Calls to the add on instruction may verify with changes applied although calling arguments may not be what is intended Check all calls to instruction to ensure they will execute correctly with updates If the data layout is different data values for tags using this type will be converted if possible and some values may be lost Check any tags using this type to ensure tag data converts as expected Cancel Help Add on instruction definition Conveyor_Control already exists in project Existing references may be affected TIP You can only rename an Add On Instruction if it has not been sealed with an instruction signature To rename an Add On Instruction that has been source protected you need the source key The Collision Details button lets you view the Property Compare tab which shows the differences between the two instructions and the Project References tab which shows where the existing Add On Instruction is used Rockwell Automation Publication 1756 PM010E EN P September 2012 89 Chapter 4 Updating an Add On Instr
72. it To stop the jog turn off this bi q Rockwell Automation Publication 1756 PM010E EN P September 2012 75 Chapter 3 76 Using the Jog Command in Ladder Diagram The first rung sets the Jog bit of Motor_Starter_LD Jog PB Conveyor Jog command for the motor To jog the motor turn on this bit Pushbutton to jog the conveyor forward To stop the jog turn off this bit Jog_PB Motor_Starter_LD Jog _ Conveyor otor_Starter Starts and stops a motor Motor_Starter Motor_Starter_LD Stop Stop_PB o Start Start_PB 0e Out Motor_Out_LD 0e Motor_Starter_LD Jog Motor_Starter tag dot Jog Parameter Use another instruction an assignment or an expression to read or write to the tag name of the parameter Use this format for the tag name of the parameter Add_On_Tag Parameter Where Is Add_On_lag An instance tag defined by the Add On data type Parameter Name of the parameter Using the Jog Command In Function Block Diagram Any parameter can be made visible or invisible except those defined as required Required parameters are always visible Ifthe parameter is required you will see it checked in the Properties dialog box 1 Click Properties for the instruction 7 Stop 7 Start 2 Check the Vis checkbox of the Jog parameter to use it in your diagram 3 Click OK Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 3 Motor_S
73. ize as your definition pass an array tag that is larger than your definition When developing your logic use the Size instruction to determine the actual size of the referenced array to accommodate this flexibility TIP When you monitor an array InOut parameter inside of the logic routine the parameter definition is used to determine the size of the array For example assume you have defined an InOut parameter to be a 10 element array of DINTs and the end user passes in an array of 100 DINTs Then if you open the Add On Instruction logic select the appropriate context for that call and monitor the array parameter only 10 elements will be displayed Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Determining Which Parameters to Make Visible or Required To help you know that specific data is passed into the Add On Instruction you can use required parameters A required parameter must be passed each argument for a call to the instruction to verify In Ladder Diagram and Structured Text this is done by specifying an argument tag for these parameters In a Function Block Diagram required Input and Output parameters must be wired and InOut parameters must have an argument tag If a required parameter does not have an argument associated as described above then the routine containing the call to the Add On Instruction will not verify For Output parameters making a parameter visible is useful if you do
74. led with an instruction signature you need to import the translated information or apply source protection before generating the signature You must have the source key to generate a signature or to create a signature history entry for a source protected Add On Instruction that has an instruction signature See Defining Source Protection for an Add On Instruction on page 55 for more information on source protecting your Add On Instruction Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Safety Instruction Signature When a sealed safety Add On Instruction is downloaded for the first time a SIL 3 safety instruction signature is automatically generated For details on how to certify a safety Add On Instruction refer to the GuardLogix Controller Systems Safety Reference Manual publication 1756 RM093 Programming Languages Select the programming language based on the type of application you are developing Ladder Diagram Function Block Diagram and Structured Text can be used for Add On Instruction logic Each of the programming languages supported in the Logix Designer application is targeted for different types of applications and programming styles In general Ladder Diagram executes simple boolean logic timers and counters the fastest Function Block Diagrams and Structured Text may be more efficient if you take advantage of the more advanced process and drives instructions available in those
75. mprove this document complete this form publication RA DU002 available at http www rockwellautomation com literature Rockwell Otomasyon Ticaret A S Kar Plaza Ig Merkezi E Blok Kat 6 34752 erenk y stanbul 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 1756 PM010E EN P September 2012 Supersedes Publication1756 PM010D EN P November 2011 Copyright 2012 Rockwell Automation Inc All rights reserved Printed in the U S A
76. n Instruction to explain the purpose of the instruction Click the Parameters tab and enter a meaningful description for each Parameter Right click each routine located below the Add On Instruction in the Controller Organizer and choose Properties Enter a description for execution of each routine a For the logic routine describe execution of the instruction when Enableln is true b For the EnableInFalse routine if one exists describe actions that will take place when EnablelIn is false such as any outputs that get cleared c For the Prescan routine if one exists briefly describe actions that will take place during the Prescan routine such as initialization of any parameters d For the Postscan routine if one exists briefly describe actions that will take place during the Postscan routine such as initialization of any parameters resetting any internal state of the instruction Click the Help tab of the Add On Instruction Definition Editor and enter additional information in the Extended Description field The extended description can include the following information Additional parameter information Description of how the instruction executes Change history notes Rockwell Automation Publication 1756 PM010E EN P September 2012 61 Chapter 2 7 Review the Help format in the preview window This is an example of the Logix Designer application generated help for the instruction Motor_ Starter v1 0
77. n The description revision revision note and vendor information is copied into the custom help for the instruction The revision is not automatically managed by the software You are responsible for defining how it is used and when it is updated Add On Instruction Definition Simulation_DT_ 1st EX General Parameters Local Tags Scan Modes Signature Change History Help Name Simulation DT_1st Description Simulation instruction which includes a dead time and a first order lag Iype 3 Function Block Diagram Change Type Major Minor Extended Text Revision 1 3 0 SimDT 1st Revision Note Vendor Rockwell Automation ete ical tags whose value Data Type Size 276 byte ls Class information for safety controller projects appears on the General tab as well The class can be standard or safety Safety Add On Instructions must meet requirements specific to safety applications See Safety Add On Instructions on page 19 for more information Add On Instruction Definition SafetyAddOnInstru ooo General Parameters Local Tags Scan Modes Signature Change History Help Name SafetyAddOnInstruction Description Class Safety lt Type ED Ladder Diagram Change Type Rockwell Automation Publication 1756 PM010E EN P September 2012 13 Chapter 1 Parameters The parameters define the instruction interface that is how the i
78. n tab that lists all of the currently available Add On Instructions in the project 4 Hi est test Sor os So Sen Pat 2 4 R Favorites Add On Bit Timer Counter Input Outp Element Group Add On IMPORTANT Safety Add On Instructions can be used only in safety routines which are currently restricted to ladder logic Safety Add On Instructions are shown in the Language Element Toolbar only when the routine is a safety routine Rockwell Automation Publication 1756 PM010E EN P September 2012 71 Chapter 3 Using the Add Element Dialog Box 72 Follow these instructions to access the Add language Element dialog box 1 Press Alt Insert anywhere in the editor or by right clicking the logic in the Editor I Motion Move 4 Motion Group H Motion Event fH Motion Config HHO Motion Coordinated 4 ASCII Serial Port 4 ASCII String 4 ASCII Conversion Hy Debug x E Simulate_ FeedbeSimdates a S diotal feedback device i m Simulation_DT_1Simulation instruction which includ f Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 3 3 Select the Add On Instruction and click OK HOI Motion Coordinated E ASCII Serial Port HE ASCII String Contact the Add On Instruction develope Starts and stops a motor Available Languages Simulate_FeedbeSimulates a digital fe
79. nablelnFalse OK Description Type E Function Block Diagram v Instruction Simulation_DT_1st C Open Routine 5 Type a description of the EnableInFalse behavior 6 Click OK to add an EnableInFalse routine to the Add On Instruction definition 7 Define if EnableIn False routine executes or not by checking or clearing Execute EnableInFalse routine Fa EnablelnFalse routine Executes when the Enableln parameter is false Execute EnablelnFalse routine The EnableInFalse routine can now be edited like any other routine The EnableIn and EnableOut parameters that appear by default in every Add On Instruction have behaviors that conform to the three language environments Ladder Diagram Function Block Diagram and Structured Text To execute the primary logic routine in any of the language environments the EnableIn parameter must be True 1 In general the EnableIn parameter should not be referenced by the primary logic routine within the instruction definition The EnableOut parameter will by default follow the state of the EnableIn parameter but can be overridden by user logic to force the state of this Parameter TIP If Enableln is False then EnableOut cannot be made True in an Enableln False routine If the EnableIn parameter of the instruction is False 0 the logic routine is not executed and the EnableOut parameter is set False 0 If an EnableInFalse routine is included in the instruction definition and it
80. ned Data Type there is only one shared copy in the project file When an Add On Instruction is copied to another project it also copies any instruction it references to the target project Rockwell Automation Publication 1756 PM010E EN P September 2012 83 Chapter 3 Notes 84 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 4 Introduction Creating an Export File Importing and Exporting Add On Instructions Topic Page Creating an Export File 85 Importing an Add On Instruction 88 Updating an Add On Instruction to a Newer Revision via Import 90 When you choose to export an Add On Instruction the exported Add On Instruction includes all of its parameters local tags and routines These will be imported with the Add On Instruction automatically Optionally you can include any nested Add On Instructions or User Defined Data Types that are referenced by the exported Add On Instruction Referenced Add On Instructions and data types are exported to the L5X file if you select Include all referenced Add On Instructions and User Defined Types during the export Add On Instruction definition references may also be exported when a program routine set of rungs or User Defined Data Type is exported TIP If an Add On Instruction uses Message MSG instruction and InOut parameters of type MESSAGE you may wish to export a rung containing the Add On Instruction to include the MESSAGE
81. nstruction appears when used The parameter order defines the order that the parameters appear on the instruction call Add On Instruction Definition Simulation_DT_1st v1 0 Sim DT 1st General Parameters Local Tags Scan Modes Signature Change History Help _ Name Usage Data Type Alas For _ Defaut Style Req vis Description ExtemalAccess Constant _ BOOL 1 Decimal 1 Enable Input Sys Read Only EnableOut Output BOOL 0 Decimal C E Enable Output S Read Only SimDTInv Output BOOL 0 Decimal v If on the dead tim Read Only Simlnput Input REAL 0 0 Float v V Enter the tag for t Read Write SimDeadtime Input REAL 0 0 Float Enter the dead tim Read Write SimTimeConst Input REAL 1 0 Float Enter the time con Read Write SimOutput Output REAL 0 0 Float Lah Output value of th Read Only InQut REAL 100 Float Enter an array of 1 Do00000000 Move Up Move Down Copy all default values of parameters and local tags whose values were modif all tags of this instruction type Data Type Size 276 byte s Local Tags The Local Tags tab defines tags that are used by the logic within the Add On Instruction and are not visible outside the instruction Other Add On Instructions or programs in the project cannot access these tags The only way to make a local tag or one of its members accessible from outside th
82. ogic 1 Right click the instruction call in any routine lotor_Starter Starts and stops a motor PETEA Motor Starter LD EE Motor_Starter Mo or_Starter_ST Stop_PB Star Stop Stop_PB PD MUU ST 0e Start Start _PB 0e Out Motor_Out_LD 0e Pushbutton to stop the conveyor 0 Sto p_PB D Motor Starter Eni Output command to Starts andstopsa motor the conveyor motor 2 Motor_O ut FBD Pushbutton to start the conveyor o Stat PB D Pushbutton to jog panom the conveyor fonward pr gt 2 Choose Open Instruction Logic Open Instruction Logic Open Instruction Definition Properties Alt Enter The Language Editor opens with the Add On Instruction s logic routine and with data values from the instruction call As you view the logic you can Identify the instruction call whose tags are being used for data See the logic as it executes when online See Parameter and Local Tag values Change local tag and parameter values for the data instance selected Rockwell Automation Publication 1756 PM010E EN P September 2012 79 Chapter 3 See Parameters and Local Tag Change Local Tag and Parameter values Data Context identifies the instruction call by its values for that data context instance tag being used for data Er ENI Enter the tag for Enter the time in the output command milliseconds that it to the output To simulate a fault takes
83. ogram code will work correctly with the new version of the instruction For more information on updates to arguments see Updates to Arguments Following Parameter Edits on page 41 5 Click Close and then OK to complete the operation Rockwell Automation Publication 1756 PM010E EN P September 2012 A access Add On Instructions 71 Add Element dialog box 72 Add 0n Instruction Definition Editor 37 alias parameter 28 37 array 28 C Change History tab 17 changing class 53 dass 13 changing 53 collision import 89 91 compare instructions 91 constant value tags 31 copy Add On Instruction 82 default values 43 instruction signature 56 safety Add On Instruction 82 safety instruction signature 57 signature history 57 Copy Default Values dialog box 44 create Add On Instruction 35 alias parameter 37 EnableinFalse routine 50 instruction help 61 instruction signature 56 local tags 39 logic 44 parameters 37 postscan routine 49 prescan routine 47 signature history 57 data access 24 data access control 30 data context views 54 data types alias 28 parameters 27 37 size 22 tags 40 default values 38 40 copy 43 delete safety instruction signature 58 Edit Tags tab 41 Enableln parameter 51 Index Function Block Diagram 52 ladder diagram 52 structured text 52 EnablelnFalse routine 50 create 50 EnableOut parameter 51 export 85 88 external access 31 F Function Block Diagram inst
84. on 1756 PM010E EN P September 2012 Chapter 1 Considerations When Creating Parameters Consider the following information when you are creating parameters Passing Arguments to Parameters by Reference or by Value The following information will help you understand the differences between passing argument tags to parameters by reference or by value Aspect By Value Input or Output By Reference InOut Value Synchronous the argument s value does not Asynchronous the argument s value may change during Add On Instruction execution change during Add On Instruction execution Any access by the instruction s logic directly reads or writes the passed tag s value Performance Argument values are copied in and out ofthe Parameters access argument tags directly parameters of the Add On Instruction This by reference which leads to faster takes more time to execute a call to the execution of instruction calls instruction Memory usage Most amount Least amount Parameter data types Atomic SINT DINT INT REAL BOOL Atomic arrays and structures supported Selecting a Data Type for a Parameter The Logix5000 controllers perform DINT 32 bit and REAL 32 bit math operations which causes DINT data types to execute faster than other integer data types Data conversion rules of SINT to INT to DINT are applied automatically and can add overhead Whenever possible use DINT data types for the Add On Instruction
85. on on safety application requirements the safety task signature and configuring and operating safety controllers refer to these publications GuardLogix Controller Systems Safety Reference Manual publication 1756 RM093 Compact GuardLogix Controllers User Manual publication 1768 UM002 GuardLogix Controllers User Manual publication 1756 UM020 GuardLogix Safety Application Instruction Set Safety Reference Manual publication 1756 RM095 Rockwell Automation Publication 1756 PM010E EN P September 2012 Preface Understanding Terminology This table defines some of the terms used in this manual when describing how parameters and arguments are used in Add On Instructions Term Argument Definition An argument is assigned to a parameter of an Add On Instruction instance An argument contains the specification of the data used by an instruction in a user program An argument can contain the following A simple tag for example L101 A literal value for example 5 A tag structure reference for example Recipe Temperature A direct array reference for example Buffer 1 An indirect array reference for example Buffer Index 1 A combination for example Buffer Index 1 Delay Parameter Parameters are created in the Add On Instruction definition When an Add On Instruction is used in application code arguments must be assigned to each required parameter of the Add On Instruction InOut parameter
86. ontrol already exists in project and is different Existing references to the instruction type may be affected including logic that calls instruction tags of this instruction type add on instructions and user Revision Revision Note Vendor Rockwell Conveyor_Control already exists in project and is different Existing references may be affected Calls to the add on instruction may verify with changes applied although calling arguments may not be what is intended Check all calls to instruction to ensure they will execute correctly with updates If the data layout is different data values for tags using this type will be converted if possible and some values may be lost Check any tags using this type to ensure tag data converts as expected OK Cancel Help Add on instruction definition Conveyor_Control already exists in project Existing references may be affected 4 Click Collision Details to see any differences in the Add On Instructions and to view where the Add On Instruction is used The Property Compare tab shows the differences between the instructions in this case the Revision Edited Date and Software Revision Add On Instruction Name Collision Conveyor_Control x Property Compare Project References Differences are highlighted Import Add On Instruction Existing Add On Instruction 2 0 Rockwell 10 24 2005 6 50 43 PM NA Mills 15 27 2009 4 39 12 PM NA srdennis Execute Prescan
87. or a Local Tag on page 28 Unavailable Instructions within Add On Instructions Most built in instructions can be used within Add On Instructions The following instructions cannot be used Unavailable Instruction Description BRK Break EOT End of Transition EVENT Event Task Trigger FOR For For Next Loop 10T Immediate Output JSR Jump to Subroutine JXR Jump to External Routine MAOC Motion Arm Output Cam PATT Attach to Equipment Phase 24 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Unavailable Instruction Description PCLF Equipment Phase Clear Failure PCMD Equipment Phase Command PDET Detach from Equipment Phase POVR Equipment Phase Override Command RET Return SBR Subroutine SFP SFC Pause SFR SFC Reset Safety application instructions such as Safety Mat SMAT may be used in safety Add On Instructions only For detailed information on safety application instructions refer to the GuardLogix Safety Application Instruction Set Safety Reference Manual publication 1756 RM095 In addition the following instructions may be used in an Add On Instruction but the data instances must be passed as InOut parameters ALMA Analog Alarm ALMD Digital Alarm All Motion Instructions MSG Message Rockwell Automation Publication 1756 PM010E EN P September 2012 25 Chapter 1 Using GSV and SSV Instructions When using GSV and SSV instructions inside an Add On Instruc
88. or de energizing instruction outputs automatically when the action is finished TIP Because safety Add On Instructions cannot be called from an SFC Action this option is not available for safety Add On Instructions 48 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Follow these steps to create a postscan routine 1 In the Controller Organizer right click an instruction and choose Open Definition 2 Click the Scan Modes tab 3 Click New for Postscan Routine Add On Instruction Definition Simulation_DT_1st _ BX General Parameters Local Tags Scan Modes Signature Change History Help The controller prescans and postscans the Add On Instruction Logic routine but will not execute the Logic routine when Enableln is false Optional Prescan Postscan and EnablelnFalse routines may be configured below Prescan routine Executes prior to first scan on transition from program to run New Postscan routine Executes on last scan of a step if SFC is configured for automatic reset EnablelnFalse routine Executes when the Enableln parameter is false Copy all ault values of parameters and local tags whose value Data Type Size 276 byte s Cancer 4 From the Type menu on the New Scan Mode Routine dialog box choose the type of programming language Ladder Diagram Function Block or Structured Text New Scan Mode Routine Mode Postscan OK Description
89. r you can use a custom language to tailor documentation to a specific type of project file user Enter the localized descriptions in your project either when programming in that language or by using the import export utility to translate the documentation offline and then import it back into the project Once you enable project documentation in application you can dynamically switch between languages as i you use the software Project documentation that supports multiple translations includes these variables e Component descriptions in tags routines programs equipment phases user defined data types and Add On Instructions e Engineering units and state identifiers added to tags user defined data types or Add On Instructions e Trends e Controllers e Alarm Messages in configuration of ALARM_ANALOG and ALARM_DIGITAL tags e Tasks e Property descriptions for module in the Controller Organizer e Rung comments SFC text boxes and FBD text boxes If you want to allow project documentation on an Add On Instruction that is sealed with an instruction signature you must enter the localized documentation into your Add On Instruction before generating the signature Because the signature history is created after the instruction signature is generated the signature history is not translatable If the translated information already exists when you generate the Add On Instruction signature you can switch the language while keeping the
90. r Safety The Class field is available on the New Add On Instruction dialog box for safety controller projects 6 Choose a programming language for Add On Instruction logic The language Type defaults to Ladder Diagram for safety Add On Instructions 7 Assign a Revision level for the instruction 8 Write a Revision note if necessary 9 Add information about the Vendor if necessary 10 Click OK to create the instruction 36 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Creating a Parameter Use the Add On Instruction Definition Editor to create the parameters for your instructions Follow these steps to define the parameters for your instruction 1 In the Controller Organizer right click an Add On Instruction and choose Open Definition 2 Click the Parameters tab and enter a name for a parameter Add On Instruction Definition Simulate_Feedback v1 0 General Parameters Local Tags Scan Modes Signature Change History Help prane a Usage Data Type Alias For Default Style Reg Vis Description External Access Constant Enableln Input BOOL 1 Decimal C Enable Input Sys Read Only EnableOut Output BOOL 0 Decimal Enable Output S Read Only OutCommand Input BOOL 0 Decimal Enter the tag for t Read Write 2 SimulateF ault Input BOOL 0 Decimal To simulate a fault Read Write DelayTime Input DINT 9 Decimal Enter the time in m Read Write Inpu
91. r to the LogixS000 Controllers Execution Time and Memory Use Reference Manual publication 1756 RM087 Rockwell Automation Publication 1756 PM010E EN P September 2012 33 Chapter 1 Scan Mode Routines Test Do you need to provide Scan mode routines You can optionally define the scan behavior of the instruction in different Scan modes This lets you define unique initialization behaviors on controller startup Program gt Run SFC step postscan or EnableIn False condition In what language do Scan mode routines need to be written How will you test the operation of your Add On Instruction before commissioning it What possible unexpected inputs could the instruction receive and how will the instruction handle these cases Help Documentation What information needs to be in the instruction help When you are creating an instruction you have the opportunity to enter information into various description fields You will also need to develop information on how to use the instruction and how it operates 34 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Introduction Creating an Add On Instruction Rockwell Automation Publication 1756 PM010E EN P September 2012 Defining Add On Instructions Topic Page Creating an Add On Instruction 35 Creating a Parameter 37 Creating Local Tags 39 Editing P
92. rameters are passed values Prescan Executes the main logic routine of the Add On Instruction in Prescan mode Any required Input and Output parameters values are passed Postscan Executes the main logic routine of the Add On Instruction in Postscan mode For each Scan mode you can define a routine that is programmed specifically for that Scan mode and can be configured to execute in that mode Scan Mode Result True The main logic routine for the Add On Instruction executes not optional False The Enableln False routine executes normally in place of the main logic when a scan false of the instruction occurs Any required or wired in FBD Input and Output parameters values are passed Prescan The Prescan routine executes normally after a prescan execution of the main logic routine Any required Input and Output parameters values are passed Postscan The Postscan routine executes normally after a postscan execution of the main logic routine The Scan Modes tab in the Instruction Definition Editor lets you create and enable execution of the routines for the three Scan modes Prescan Postscan and EnableInFalse Prescan Routine When the controller transitions from Program mode to Run mode or when the controller powers up in Run mode all logic within the controller is executed in Prescan mode During this scan each instruction may initialize itself and some instructions also initialize any tags they may re
93. rom being edited without resulting in a change to the signature An Add On Instruction can be used across multiple projects You can define the instructions the instructions can be provided to you by someone else or they can be copied from another project Once defined in a project they behave similarly to the built in instructions already available in the Logix Designer application They appear on the instruction toolbar and in the instruction browser for easy access just like built in Logix Designer application instructions Like standard Add On Instructions safety Add On Instructions let you encapsulate commonly used safety logic into a single instruction making it modular and easier to reuse In addition to the instruction signature used for high integrity Add On Instructions safety Add On Instructions feature a SIL 3 safety instruction signature for use in safety related functions up to and including SIL 3 Refer to the GuardLogix Controller Systems Safety Reference Manual publication 1756 RM093 for details on certifying safety Add On Instructions and using them in SIL 3 safety applications 12 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Components of an Add On Instruction Add On Instructions are made up of the following parts General Information The General tab contains the information you enter when you first create the instruction You can use this tab to update that informatio
94. rt button The motor stops RunCommand JF E J RunCommand 3 The motor starts if the run command is on The motor also starts if the Jog input is on and there isnt a faut Output command to the motor starter If on the motor starts If off the motor stops RunCommand Out 1 TE JC Jog command for the motor To jog the motor turn on this bit If on the motor To stop the jog didnt start or turn off this bit stop Jog Fault JE el fae If FauttTime is greater than 0 turn on CheckAuxContact This lets the instruction use the auxiliary contact of the motor Time ms to weit for the auxiliary contact to open or close The Faut bit turns on when that time is up RT MOV CheckAuxContact 2 Greater Than A B Move Source A FaultTime Source FaultTime 04 04 Source B 0 Dest FaultTimer PRE o If CheckAuxContact is on the rung checks for that state of the auxiliary contact The Fault bit turns on if the auxiliary contact doesn t match the commanded state of the motor within FautTime Auxiliary contact of Output command to the motor the motor starter Make sure you set If on the motor the FeultTime starts Otherwise this If off the motor input doesn t do stops anything CheckuxContact Out AuxContact TON 3 J J j Timer On Delay HEN Timer FauttTimer Auxiliary contact of Output command to the motor pie oe ccum o the motor starter Make sure you set If on the motor the F
95. ruction example 74 G General tab 13 generate instruction signature 56 GSV 26 help create 61 example 62 Help tab 18 l import 88 92 Import Configuration dialog box 91 instruction size 22 toolbar 71 instruction signature changing 20 copy 56 definition 16 generate 56 language switching 20 63 remove 56 restricted actions 16 20 source protection 20 L Ladder Diagram instruction example 74 language switching 63 instruction signature 20 Last Edit Date 57 local tags create 39 external access 40 planning 33 Local Tags tab 14 create tags 40 logic 44 Rockwell Automation Publication 1756 PM010E EN P September 2012 93 execution 44 M monitor data values 79 parameter values 77 move parameter 38 naming conventions 32 36 nesting 22 data access 24 planning 33 0 object classes 26 P parameter alignment 41 42 parameters alias 28 create 37 Enableln 51 EnableOut 51 monitor 77 move 38 planning 32 reorder 38 required 29 visible 29 30 Parameters tab 14 create a parameter 37 passing arguments 27 performance 45 planning 32 postscan routine 48 create 49 prescan routine 46 create 47 programming language choosing 21 planning 33 programming tips 75 Project References tab 92 Property Compare tab 91 remove instruction signature 56 reorder parameters 38 required parameters 29 routine EnablelnFalse 50 postscan 48 prescan 46 S safety dass 13 restrictions 19 tags 30 saf
96. s For an additional level of technical phone support for installation configuration and troubleshooting we offer TechConnect support programs For more information contact your local distributor or Rockwell Automation representative or visit http www rockwellautomation com support 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 support americas phone_en html or contact your local Rockwell Automation representative New Product Satisfaction Return Rockwell Automation tests all of its products to 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 i
97. s of Routines and Add On Instructions Aspect Main Routine Subroutine Add On Instruction Edit Online offline Online offline Offline only Import export Entire routine including Entire routine including tags and instruction Full instruction definition including routines and tags to L5X tags and instruction definitions to L5X definitions to L5X Instruction signature N A N A 32 bit signature value seals the instruction to prevent modification and provide high integrity Programmatic Access to Data Input and Output parameters and local tags are used to define an instruction defined data type Each parameter or local tag has a member in the data type although local tag members are hidden from external use Each call to an Add On Instruction uses a tag of this data type to provide the data instance for the instruction s execution The parameters of an Add On Instruction are directly accessible in the controller s programming via this instruction defined tag within the normal tag scoping rules Local tags are not accessible programmatically through this tag This has impact on the usage of the Add On Instruction Ifa structured including UDTs array or nested Add On Instruction type is used as a local tag not InOut parameters then they are not programmatically available outside the Add On Instruction definition TIP You can access a local tag via an alias parameter See Creating an Alias Parameter f
98. s z a e My Recent Documents Desktop 9 My Documents PE My Computer ar File name Sean My Network Save as type RSLoaix 5000 XML File L5 x Cancel Places J Include all referenced Add On Instructions and User Defined Types Help rth Z 3 Type a name for the file 4 Clear Include referenced Add On Instructions and User Defined Types 5 Click Export 6 Follow the above steps to individually export the other shared Add On Instructions and User Defined Data Types Using export in this way lets you manage the shared Add On Instruction and User Defined Data Types independently of the Add On Instructions that reference them One advantage of this is the ability to update the shared component without having to regenerate all the export files for the instructions that reference it That is it is only stored in one file instead of in every file whose instruction references it This can help with the maintenance of the instructions as you only have to update one export file To use Add On Instructions that have been exported in a separate file without references you must first import any User Defined Data Types of Add On Instructions that the exported instruction references before the import of the referencing instruction can be successful To do this work from the bottom up Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 4 Import the lowest level User D
99. safety Add On Instruction is downloaded for the first time a SIL 3 safety instruction signature is automatically generated Once created the safety instruction signature is compared at every download If the Logix Designer application detects an invalid safety instruction signature value it generates a new safety instruction signature value in the offline project and displays a warning indicating that the safety instruction signature was changed The safety instruction signature is deleted if the instruction signature is removed IMPORTANT After testing the safety Add On Instruction and verifying its functionality you must record the instruction signature the safety instruction signature and the timestamp value Recording these values will help you determine if the instruction functionality has changed Refer to the GuardLogix Controller Systems Safety Reference manual publication 1756 RM093 for details on safety application requirements Viewing and Printing the Instruction Signature When the instruction signature has been generated the Logix Designer application displays the instruction with the blue seal icon in the Controller Organizer on the Add On Instruction title bar and in the Logic Editor o Add On Instructions Oonveyor Control Parameters and Local FA Logic TIP When an instruction is sealed the instruction signature is displayed on the faceplate of the instruction in the Ladder Diagram Editor and the
100. t DINT 9 Decimal Read Write Data Type Size byte s 3 Define the Usage based on the type of parameter Input Output InOut TIP An instruction with only Input parameters except EnableOut is treated as an input instruction in a Ladder diagram and is displayed left justified The EnableOut parameter is used for the rung out condition 4 Select a data type with the following options based on the parameter usage An Input parameter is passed by value into the Add On Instruction and must be a SINT INT DINT REAL or BOOL data type An Output parameter is passed by value out of the Add On Instruction and must be a SINT INT DINT REAL or BOOL data type An InOut parameter is passed by reference into the Add On Instruction and can be any data type including structures and array TIP REAL data types are allowed for 1756 L7xS controllers 5 Ifthis parameter is intended as an alias for an existing local tag click the Alias For menu to choose the local tag or its member TIP You can also designate a parameter as an alias for a local tag by using the Tag Editor See Editing Parameters and Local Tags on page 4 Rockwell Automation Publication 1756 PM010E EN P September 2012 37 Chapter 2 38 6 10 11 12 TIP Set the default values Default values are loaded from the Add On Instruction definition into the tag of the Add On Instruction data
101. t equal to the value of the auxiliary contact tag Copy all default values of paramet instruction type Data Type Size 20 byte s Signature 1D 48F181FC Timestamp 2009 07 317 00 14 35 4492 General Signature History User io Timestamp Description NA selnis 48F181FC 2009 07 31T00 14 35 4492 signature for high integrity Name Description Execution see Add On Instruction Scan Modes online Help for more information Type BB Ladder Diagram ondition Description In Instruction Motor Starter Enableln is true OutCommand turns on when Stop and Start are on a OutCommand turns off when Stop turns off Enableln is false OutCommand turns off Fault timer resets Number of Rungs 1 Revision v1 0 Notes 62 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Project Documentation With RSLogix 5000 software version 17 and later you have the option to display project documentation such as tag descriptions and rung comments in any supported localized language You can store project documentation for multiple languages in a single project file rather than in language specific project files You define all the localized languages that the project will support and set the current default and optional custom localized language The software uses the default language if the current language s content is blank for a particular component of the project Howeve
102. tarter Properties Motor_Starter_FBD Sheet 1 X Faaneiens Tag EEEE eT a Enableln 1 BOOL Enable Input System Defi o C EnableOut 1 BOOL Enable Output System De m M Stop 0 BOOL Enter the tag that gives the m M Stat 0 BOOL Enter the tag that gives the gt Jog 0 BOOL Jog command for the motor m F AuxContact 0 BOOL Ausiliary contact of the mot yO ClearFault 0 BOOL To clear the fault of the mo 0 Out 0 BOOL Output command to the mo a m Fault 0 BOOL If on the motor didn t start wmi ere n ner Pear remy Dee ET 4 Wire to the pin for the parameter Pushbutton to stop the conveyor Stop_PB a Pushbutton to start the conveyor 0 Sta t_PB E Pushbutton to jog the conveyor fonvard pars gt Conveyor 1 otor_Starter_FBD MotorStarter E Output comm and to Starts an d stops a motor the conweyor motor a Motor_O ut_F BD eae Using the Jog Command in Structured Text The assignment sets the Jog bit of Motor_Starter_ST Jog_PB Motor_Starter_STJog Jog_PB Start_PB Motor_Out_ST Motor_Starter_ST Jog Motor_Starter tag dot Jog Parameter Monitoring the Value of a Follow this procedure when you want to see or change a parameter value of an Parameter Add On Instruction 1 Open the Properties of the instruction based on what language you are using Rockwell Automation Publication 1756 PM010
103. te arguments with parameters Therefore if two different parameters have the same name but different operational definitions importing or pasting may impact the behavior of the instruction 42 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Copying Parameter or Local Tag Default Values In RSLogix 5000 software version 18 or later you can choose to copy parameter or local tag default values to all tags of the Add On Instruction data type or just to specific tags You can do so only when you are offline ATTENTION Values cannot be modified when the instance tags are part of a source protected Add On Instruction or you do not have sufficient permission to make edits If you modify the default values of a parameter or local tag by using the Add On Instruction Definition Editor you can choose to copy the modified values to all of the tags of the Add On Instruction data type by checking Copy all default values of parameters and local tags whose values were modified to all tags of this instruction type Add On Instruction Definition Simulate_Feedback v1 0 a General Parameters Local Tags Scan Modes Signature Change History Help Enableln Enable0ut Alias For Req vis Description ExtemalAccess 1 Decimal E Enable Input Sys Read Only D Decimal E Enable Output S Read Only OutCommand Decimal M Enter the tag for t Read Write SimulateF ault 5 Decimal
104. te bere tok alte 46 Presean ROCUInEs5 E E oes Dat ae Ke 46 Postscarn ROUGE cies itt tenets sod esac ae errs obit artes ise add ep 48 EnableInFalse Routine 0 s005cicacisced oidudda ves eeedend dete 50 Using the EnableIn and EnableOut Parameters 0006 51 EnableIn Parameter and Ladder Diagram 00 008 52 EnableIn Parameter and Function Blocks 000 cee ees 52 EnableIn Parameter and Structured Text 0c0ceeeeees 52 Changing the Class of an Add On Instruction 0006 53 Testing the Add On Instruction s cninatasee lan awe eeegataraes 53 Betore Yous Lest i405 0i oie urate cd ei ea ade oa eueie eae 4 54 Testing the Blowsi 5 lt 068 dete tun en Er ENE EELEE 54 Monitoring Logic with Data Context Views 0 000005 54 Verifying Individual Sean Modes Ss c0dnkves ceeverses wow nimiens 55 Defining Source Protection for an Add On Instruction 55 Enable the Source Protection Feature cceececeeeeees 56 Generating an Add On Instruction Signature 0 0008 56 Generating Removing or Copying an Instruction Signature 56 Creating a Signature History Entty cicuscstnntic decades 57 Generating a Safety Instruction Signature 00 000 58 Viewing and Printing the Instruction Signature 58 Creating Instruction bel praiaus crawe ony icovee wet Aha caeteeewecess 59 Writing Clear Descriptions lt 5 9556s oe ncsecs
105. ter of the BOOL tag type that is not required but visible will show as a status flag on the right side of the block in Ladder This can be used for status flags like DN or ER Rockwell Automation Publication 1756 PM010E EN P September 2012 29 Chapter 1 Parameter Type Input Is the Parameter Required Is the Parameter Visible This table explains the effects of the Required and Visible parameter settings on the display of the instruction Table 2 Input Output and InOut Required and Visible Settings Ladder Diagram Function Block Diagram Structured Text Does the Does the Do You Needto Does the Can You Change the Does the Argument Value Argument Connect the Argument Visibility Setting display display display Parameter display Within the Function Block N A N Input N A Input N A Output N A Output N A Output am e o e a s N A InOut 30 So n a a a lt 2 lt lt 2 lt lt z 2 lt lt 2 lt lt lt z z lt 2 z lt z lt lt 2 lt lt lt Z Z lt Z Z lt N A Y Ifyou have a parameter for which the user must specify a tag as its source for input or its destination as output and you do not want this to be optional set the parameter as required Any required parameters are automatically set to visible The Visible setting is always set to visible for InOut param
106. the Add On Instruction developer for questions or problems with this instruction Simulation instruction which includes a dead time and a first order lag Available Languages lt Data Type Size 276 byte s When deciding whether to develop an Add On Instruction consider the following aspects Instruction Functionality Complex instructions tend to be highly application specific and not reusable or require extensive configuration support code As with the built in instructions Add On Instructions need to do one thing do it well and support modular coding Consider how the instruction will be used and manage interface complexity for the end user or application Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 1 Add On Instructions are best at providing a specific type of functionality or device control Encapsulation Add On Instructions are designed to fully encapsulate the code and data associated with the instruction The logic inside an Add On Instruction uses only the parameters and local tags defined by the instruction definition There is no direct programmatic access to controller or program scope tags This lets the Add On Instruction be a standalone component that can execute in any application that calls it by using the parameters interface It can be validated once and then locked to prevent edits Safety Add On Instructions Safety Add On Instructions are used in the safety task
107. tion the following classes are supported AddOnInstructionDefinition MotionGroup Axis Program Controller Routine Controller Device gt Redundancy CoordinateSystem Safety CST Serial Port DF1 Tak Fault Log Wall Clock Time Message 1 GSV only SSV instructions will not verify 2 The classes that represent programming components Task Program Routine AddOnInstructionDefinition support only this as the Instance Name When you enter a GSV or SSV instruction the Logix Designer application displays the object classes object names and attribute names for each instruction This table lists the attributes for the AddOnInstructionDefinition class Attribute Name Data Type Attribute Description MajorRevision DINT Major revision number of the Add On Instruction MinorRevision DINT Minor revision number of the Add On Instruction Name String Name of the Add On Instruction RevisionExtendedText String Text describing the revision of the Add On Instruction Vendor String Vendor that created the Add On Instruction LastEditDate LINT Date and time stamp of the last edit to an Add On Instruction SignaturelD DINT 32 bit instruction signature value SafetySignaturelD DINT 32 bit safety instruction signature value For more information on using GSV and SSV instructions refer to the LogixS000 Controllers General Instructions Reference Manual publication 1756 RMO003 26 Rockwell Automation Publicati
108. to plan your instruction design Advance planning can identify issues that need to be addressed When defining the requirements of an instruction you are also determining the interface Keep the following aspects in mind when defining your instruction requirements and creating your Add On Instruction Intended Behavior What is the purpose for creating the Add On Instruction What problem is it expected to solve How is it intended to function Do you need to higher level of integrity on your Add On Instruction If so you can generate an instruction signature as a means to verify that your Add On Instruction has not been modified Do you need to use safety application instructions and certify your safety Add On Instruction to SIL 3 integrity For details on how to certify a safety Add On Instruction refer to the GuardLogix Controller Systems Safety Reference Manual publication 1756 RM093 Parameters What data needs to be passed to the instruction What information needs to be accessible outside of the instruction Will alias parameters need to be defined for data from local tags that needs to be accessible from outside the Add On Instruction How will the parameters display The order of the parameters defines the appearance of instruction Which parameters should be required or visible Naming Conventions The instruction name will be used as the mnemonic for your instruction Although the name can be up to 40 characters
109. truction created in version 18 or later of RSLogix 5000 software into an older project that does not support Add On Instruction signatures causes the Add On Instruction to lose attribute data and the instruction may no longer verify Import Configuration When you select a file to import the Import Configuration dialog box lets you choose how the Add On Instruction and referenced components are imported If there are no issues you can simply click OK to complete the import If your Add On Instruction collides with one already in the project you can Rename it by typing a new unique name in the Final Name field Choose Overwrite from the Operation menu Choose Use Existing from the Operation menu import Configuration XS ef v AYA EndReplace Find Within Final Name Import Content amp Add On Instruction Configure Add On Instruction Properties a a Import Name Conveyor_Control The component collides with a Click Add On Instructions to see 4a aremeters and Local Tags ra i EBB Routines Operation Overwrite z definition already in the project the Configure Add On Instruction a i e D References will be imported as References view Ifany referenced z aoe Instructions configured in the References folders 3 5 A gt x Final Name C Control lisi il instruction definitions collide the kis kalinda Z _Colision Details Description Starts and stops a conveyor References folder
110. truction in a routine in the open project 2 Assign any arguments to required parameters for your call 3 Download the project Monitoring Logic with Data Context Views You can simplify the online monitoring and troubleshooting of your Add On Instruction by using Data Context views The Data Context selector lets you select a specific call to the Add On Instruction that defines the calling instance and arguments whose values are used to visualize the logic for the Add On Instruction TIP When troubleshooting an Add On Instruction use a non arrayed instance tag for the call to the instruction This lets you monitor and troubleshoot the instruction s logic routine with a data context Variable indexed arrays cannot be used to monitor the logic inside an Add On Instruction 54 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 2 Defining Source Protection for an Add On Instruction Follow these steps to monitor the logic 1 Go into Run mode 2 Right click the instruction call and choose Open Instruction Logic Starts andstopsa motor Motor_2_F BD Motor Starter jm Starts and stop Cut Element Ctrl X o otor_2_Stop_PB af stop Copy Element Ctrl C o otor_2_Start_P B Af Stat aT Delete Element Del Motor2Jog PB Delete Element but not Tag Add Element Alt Ins Save Instruction Defaults Edit Main Operand Description Go To Ctrl
111. type when it is created and anytime a new Input or Output parameter is added to the Add On Instruction TIP Check the box at the bottom of the Add On Instruction Definition Editor to Copy all default values of parameters and local tags whose values were modified to all tags of this instruction type if you want to update existing invocations of the instruction to the new default values For details on copying default values see Copying Parameter or Local Tag Default Values on page 43 Set the display style Check the box to make the parameter required or visible as desired See Determining Which Parameters to Make Visible or Required on page 29 If you decide to make the parameter required it will also be visible Typea description maximum 512 characters This description appears in the instruction s help Select an External Access type for Input or Output parameters Check the Constant box for InOut parameters you want to designate as constant values Repeat for additional parameters You can also create parameters by using the Tag Editor New Parameter or Local Tag dialog box or by right clicking a tag name in the logic of your routine The order that you create the parameters is how they will appear in the data type and on the instruction face To rearrange the order on the Parameter tab of the Add On Instruction Definition Editor select the parameter row and click Move Up or Move Down
112. uction When you need to update an instruction to a newer revision you can import it to a Newer Revision via Imp ort from an L5X file or copy it from an existing project You must be offline to update an Add On Instruction Follow these steps to update an Add On Instruction to a newer revision by importing it 1 Right click the Add On Instruction folder and choose Import Add On Instruction 2 Select the file with the Add On Instruction and click Import Import Instruction Look in O RSLogix5000examples 2 Ej Conveyor_Control L5X My Recent Documents Desktop My Documents File name Conveyor_Control Ea Files of type Zj Files containing E Instruction hail Into ja 90 Rockwell Automation Publication 1756 PM010E EN P September 2012 Chapter 4 3 Review the Import Configuration dialog box and from the Operations menu choose Overwrite Import Configuration A Find v amp amp Find Replace Find Within Final Name Import Content amp Add On Instructions Xa IA Parameters and Local Tags Routines amp References Add On Instructions Import Name Operation Configure Add On Instruction Properties Conveyor_Control Choose Overwrite Overwrite aA i References will be imported as configured in the References folders Errors Warnings 5 J 9 Final Name Conveyor_Control w Collision Details Description Starts and stops a conveyor Conveyor_C
113. veyor_Control fii Motor_Starter Simulate_Feedback Simulation_DT_1st Description Revision Revision Note Vendor Rockwell Data Type Siz 60 Edited 4 25 2006 11 02 23 AM Source Prote Source not available Starts and stops a conveyor v1 0 Rockwell Automation Publication 1756 PM010E EN P September 2012 81 Chapter 3 Copying an Add On Instruction You can copy an Add On Instruction into your project when it exists in another Logix Designer project After you copy the Add On Instruction you can use the instruction as is or rename it modify it and then use it in your programs IMPORTANT Use caution when copying and pasting components between different versions of the Logix Designer application Logix Designer software only supports pasting to the same version or newer version of Logix Designer application Pasting to an earlier version of RSLogix 5000 software is not supported When pasting to an earlier version the paste action may succeed but the results may not be as expected TIP When copying and pasting Add On Instructions consider these guidelines You cannot paste a safety Add On Instruction into a standard routine You cannot paste a safety Add On Instruction into a safety project that has been safety locked or one that has a safety task signature You cannot copy and paste a safety Add On Instruction while online Follow these steps to copy the Add On Instruction
114. y of the restrictions for safety Add On Instructions are violated by changing the class from standard to safety one of the following errors is displayed and the change does not succeed Routines must be of Ladder Diagram type Safety Add On Instructions do not support the Postscan routine One or more parameters or local tags have an invalid data type for a safety Add On Instruction You must edit the parameter tag or routine types before the class change can be made TIP If the safety controller project contains safety Add On Instructions you must remove them from the project or change their class to standard before changing to a standard controller type You need to test and troubleshoot the logic of an instruction to get it working TIP When a fault occurs in an Add On Instruction routine a fault log is created that contains extended information useful for troubleshooting Rockwell Automation Publication 1756 PM010E EN P September 2012 53 Chapter 2 Before You Test Before you start to test an Add On Instruction do the following 1 Open a project to debug offline TIP Add On Instructions can only be created or modified when offline You can add delete or modify tag arguments in calls to Add On Instructions while editing online but you cannot edit arguments inside the Add On Instruction while online 2 Add the Add On Instruction to the project if it is not already there Testing the Flow 1 Adda call to the ins
115. yasees co veeiees 59 Rockwell Automation Publication 1756 PM010E EN P September 2012 Using Add On Instructions Importing and Exporting Add On Instructions Index Table of Contents Documenting an Add On Instruction 0 0 0000 eee ee 61 Project WOCUMEN TATION 4 5 sso snkvaly eatiettatce se siete ge wae 63 Motor Starter Instruction Example 23 4c veeee eee eea 64 Simulation Instruction Examples cccscsi one oxhewsedvnnavetenaben 66 Ladder Diagram Configuration 2 4 cien ei tunainadensrchwiales 68 Function Block Diagram Configuration 00 0005 69 Structured Text Configurations sysaccen sasabevdvdaS ter nernte 69 Chapter 3 ItPOdetiOiny eho eos Sos aay VSM E Oa ET 71 Accessing Add On Instructions os asyexereesdenisyesee cheeses 71 Using the Add Element Dialog Box unnsrsrsrererrrrrrerer 72 Including an Add On Instruction in a Routine 0 000 73 Tips for Using an Add On Instruction 0 ccc eee eens 75 Programmatically Access a Parameter c0 is soneviuverersmeseowantns 75 Using the Jog Command in Ladder Diagram 76 Using the Jog Command In Function Block Diagram 76 Using the Jog Command in Structured Text 00 77 Monitoring the Value of a Parameter 000 cece eee eens 77 Viewing Logic and Monitor with Data Context 04 79 Determining if the Add On Instruction is Source Protected 81 Cop
116. ying an Add On nstictionninnssccienins kewy coktreeiwes ponte 82 Storing Your Add On Instructions lt 2 4900 vice sede ehayeterals 82 Chapter 4 Tnirod ctioh ne erna berets ede k ace wel pe Redes fades 85 Greatingan Export Eiles sik Auta te ad ole Ok etal a Md lt 85 Exporting to Separate Files sqcc 52 pepes sana Gotan copra 86 Exporting to a Single File vies antenaoad ewarsarathaemad wets imal gr 87 Importing an Add On Instruction 000 cece eee cence eee ee 88 Import Considerations 54 hep ccdiawswan Wades beuvaeaesenees 88 Import Configuration 25095 SeSysucines lt aelde sory ner nearets 89 Updating an Add On Instruction to a Newer Revision via Import 90 Rockwell Automation Publication 1756 PM010E EN P September 2012 5 Table of Contents 6 Rockwell Automation Publication 1756 PM010E EN P September 2012 Preface Studio 5000 Engineering and The Studio 5000 Engineering and Design Environment combines engineering Design Environment and Logix Designer Application Purpose of This Manual Additional Resources for Safety Applications and design elements into a common environment The first element in the Studio 5000 environment is the Logix Designer application The Logix Designer application is the rebranding of RSLogix 5000 software and will continue to be the product to program Logix5000 controllers for discrete process batch motion safety and drive based solutions Rockwell Software Stud
117. you have an algorithm that will be used multiple times in the same project or across multiple projects it may make sense to incorporate that code inside an Add On Instruction to make it modular and easier to reuse e Provide an easier to understand interface You can place complicated algorithms inside of an Add On Instruction and then provide an easier to understand interface by making only essential parameters visible or required You can reduce documentation development time through automatically generating instruction help e You can export an Add On Instruction to an L5X file that can then be imported into another project You can also copy and paste between projects Rockwell Automation Publication 1756 PM010E EN P September 2012 11 Chapter 1 e Protect intellectual property You can place your proprietary code inside of an Add On Instruction then use Source Protection to prevent others from viewing or changing your code e Simplify maintenance You can simplify code maintenance because Add On Instruction logic monitored in the Logix Designer application animates with tag values relative to that specific instance of the Add On Instruction e Track revisions a chang history and easily confirm instruction functionality with high integrity Add On Instructions You can add an instruction signature to your Add On Instruction which generates a unique identifier and prevents the instruction f
118. you to reference when using Add On Instructions Instruction Topic Description Instruction Help Use the instruction help to determine how to use the instruction in your code Ladder Rungs In a ladder rung consider if the instruction should be executed on a false rung condition It may improve scan time to not execute it Data Types A data type defined with the Add On Instruction is used for the tag that provides context for the execution from your code A tag must be defined of this Add On Instruction defined type on the call to the instruction Indexed Tag You can use an indirect array indexed tag for the Instruction instance One drawback is that you cannot monitor the Add On Instruction by using this as a data context Passing Data Input and Output parameters are passed by value InOut parameters are passed by reference Programmatically Accessa Follow these procedures for any language when you want to access an Add On Instruction parameter that is not available on the instruction face by default Parameter p j The following procedures demonstrate how to use the Jog parameter of the Motor Starter Add On Instructions x e Parameters Required Name DataType Usage Description Motor_Starter Motor_Starter InOut EnableIn BOOL Input EnableOut BOOL Output Stop BOOL Input Stop command for the motor Start BOOL Input Start command for the motor Jog command for the motor To jog the motor turn on this b

Logix5000 Controllers Add-on Instructions Programming Manual

Contents

Download Pdf Manuals

Related Search

Related Contents