1. Copyright © 2002 Delmar Thomson Learning Chapter 14 Documenting Your PLC System

2. Copyright © 2002 Delmar Thomson Learning Objectives  Explain what is contained in a system documentation package.  Describe why a system documentation package should be developed.  State when the documentation package is usually developed.

3. Copyright © 2002 Delmar Thomson Learning Objectives (cont’d.)  List what documentation features the typical PLC software development package offers.  Explain the value of documentation during troubleshooting.  Describe the value of documentation if you have to expand the present system.

4. Copyright © 2002 Delmar Thomson Learning Objectives (cont’d.)  Explain what a rung description is.  Describe a rung symbol and the advantage of using symbols.  State the value of documentation during system start-up.  Explain the value of documentation during an outside service person’s service call.

5. Copyright © 2002 Delmar Thomson Learning PLC System Documentation  A documentation package is an orderly collection of information concerning the configuration and operation of your system.  It is typically put together as system is designed.

6. Copyright © 2002 Delmar Thomson Learning PLC System Documentation Usage  Installation  Debugging  Start-Up  Maintenance  Modification  System duplication

7. Copyright © 2002 Delmar Thomson Learning Why Add Documentation to User Program?  Assist installers to install and start up system.  Help maintenance individuals troubleshoot and maintain system.  Provide information to operators who must understand how system works.

8. Copyright © 2002 Delmar Thomson Learning Why Add Documentation to User Program? (cont’d.)  Assist in answering system upgrade questions.  Enable outside service people understand system for maintenance, servicing or upgrade.  Allow easy reproduction of system.

9. Copyright © 2002 Delmar Thomson Learning What Should Be Included in Documentation Package?  System overview  Diagram of system configuration  I/O address assignments  Internal coil address assignments  Data table assignments

10. Copyright © 2002 Delmar Thomson Learning What Should Be Included in Documentation Package? (cont’d.)  Program printout  Control program backup  Wiring diagrams

11. Copyright © 2002 Delmar Thomson Learning Sample Diagram of System Configuration

12. Copyright © 2002 Delmar Thomson Learning Typical Wiring for a 120 VAC Input Module

13. Copyright © 2002 Delmar Thomson Learning Typical Wiring for a 120 VAC Output Module

14. Copyright © 2002 Delmar Thomson Learning Diagram of System Configuration

15. Copyright © 2002 Delmar Thomson Learning Seven-Slot Chassis with I/O Modules Assigned

16. Copyright © 2002 Delmar Thomson Learning Internal Bit Allocation Table

17. Copyright © 2002 Delmar Thomson Learning Timer Address Allocation Table

18. Copyright © 2002 Delmar Thomson Learning Integer File Allocation Table

19. Copyright © 2002 Delmar Thomson Learning Documentation and Software Packages  PLC program development software provides readily available documentation features:  Hard copy print out of all data and ladder files  Cross-reference reports  Hard copy of ladder rungs  Memory usage  Processor configuration data

20. Copyright © 2002 Delmar Thomson Learning Software Ladder Rung Documentation  Software packages provide ladder rung documentation as program is developed.  Rung documentation can be added later or modified by maintenance individuals.

21. Copyright © 2002 Delmar Thomson Learning Software Ladder Rung Documentation (cont’d.)  Software packages ladder rung documentation:  Page titles  Rung comments  Instruction symbols  Instruction descriptions  Instruction comments

22. Copyright © 2002 Delmar Thomson Learning RSLogix 500 Ladder Documentation