Control System Design Process Planning Documentation

Documentation Overview Types of Documentation Architectural Floor Plan Block Diagram Device listing Forms Programming documentation – Interface Design User Documentation Archive

General Form of Documentation All documentation should be electronically generated. Forms can be initially filled out by hand writing, but should ultimately be re- created electronically. This promotes professionalism, and appears to the customer as professional

Architectural Floor Plan Most useful for premise wiring and installation

Block Diagram Useful for planning overall install and interconnection Very helpful for systems integration planning Helps to ensure all aspects are considered Helpful during programming phase Helpful during training of users

Device listing Forms Table format listing of devices and their parameters. (Crestron Programming Kit) For each device: –location (kitchen ceiling, home theatre) –device type (incandescent light, Hitachi VCR) –Protocol (X-10, I.R., serial) –Controlled by (wall switch 5,touch-screen, ipod touch) –Network or programming Address (G-15, 03) –Cable designation –Comments(Used in scenes, macro 4, customer wants)

Programming documentation Pre-programming notes. –Interface Design –Functional Description –Flow-chart: As written documentation: Used to document the actual program. Embedded comments within the source code. This must be written with a view for a future programmer to be able to modify your system.

Interface Design Graphical depictions of the touch screen layouts. Next lecture will expand on this.

Functional Description Describes the experience the user can expect.

Flow Chart Useful for development of algorithms and low level lanquages such as Simpl+, or C type lanquages.

User Documentation Used for training the customer Used for customer reference after you leave Used by next systems integrator to upgrade or modify the system. Paper and electronic copies should be left with customer. Electronic copy is used for modification with future upgrades. Binder or file with copies of all manufacturers manuals should be left with the customer

Archiving Documentation At least 2 copies of all documentation should exist. As the systems integrator, you keep at least 1 copy for each job you work on. Best to have paper and electronic copies, with electronic copies backed up Customer should have paper copies of user documentation plus electronic copy of all documentation

Program Design Kit The Crestron Program Design Kit is a good example of pre-program documentation It includes panel design templates and device listing forms It is considered the first part of the overall System Design Process

Program Documentation The program should be documented with embedded comments. In addition, organization practices of the programming language should be implemented. For Crestron Simpl the program logic should be organized in sub-systems.

As Built Once the program is complete, tested and turned over to the client, the documentation should be edited and modified “as built”. This is necessary since during the design, program and debug phases, changes occur. The final documentation must represent the actual product.