README.md

Introduction

The design and delivery of high-performance control sequences is a challenge! Writing accurate and detailed sequence of operations documents requires significant skill. Even starting from an existing sequence (such as ASHRAE Guideline 36) is tricky work and requires careful editing when done manually. The ctrl-flow High Performance Control Design Tool is a web-based tool intended to help designers develop an accurate sequence document. The tool was developed by Lawrence Berkeley National Lab under funding from the Department of Energy and is available for use at no charge.

Tool Structure and Vision

The structure of ctrl-flow is intended to make it readily extensible to support a broad range of systems as well as deliverable options. The tool is supported by a set of “templates” that are defined in an open standard modeling language called Modelica. The user can select the desired systems and how they should be configured for a project. Based on the user selections, the initial release of the tool will output a properly edited sequence of operation based on ASHRAE Guideline 36 – 2021. The use of the templates allows for expansion (in future releases) of the tool to support new system types as well as for a set of additional outputs. Examples of future outputs include not just the sequence of operation document, but also detailed points lists, system diagrams, and the specific control logic represented in the “Control Description Language”(CDL) and the Control eXchange Format (CXF) both of which will be defined in the proposed ASHRAE Standard 231P (A Controls Description Language). Finally, the tool will also provide a Modelica model of the desired HVAC system. CDL will be able to be used with additional tools (such as OpenModelica) to test the control system during design. CXF will be able to be used as a format to import the defined logic into tools used for setup and programming of commercial control products which comply with ASHRAE 231P. Finally, users will be able to utilize the CDL and the Modelica systems model with tools such as Spawn of EnergyPlus to do detailed energy studies of building mechanical and control systems.

Initial Release

The initial release of the tool has both a limited number of templates supported (multi-zone air handling unit, cooling only VAV terminal, VAV terminal with reheat) and only a single deliverable (edited Guideline 36 sequence in .docx format). When you first enter the tool, there is a brief pop-up tutorial which lists the steps needed to use the tool. In summary:

1. Select Project Options: For each project you can select the units (IP or SI), relevant energy code (ASHRAE 90.1 or California Title 24), and ventilation code (ASHRAE 62.1 or California Title 24). You are also asked to select the relevant climate zone (ASHRAE Climate Zone or California Title 24 Climate Zone). These system options are used to accurately edit the Guideline 36 sequence document so that only the relevant options are shown, and all others are omitted.
2. Select Systems: In this initial release the systems available are multi-zone Air Handling unit, cooling only VAV terminal, and VAV terminal with reheat. Future releases will expand system options to include fan powered VAV, Single Zone Air handlers, Chiller Plants, Boiler Plants, etc.
3. Configure Systems: Each system needs to be configured. Select the “Configs” option at the bottom of the page. This will show all selected systems. Clicking on “Edit” will allow you to configure the options desired for each system. If you have multiple configurations (for example, some zones have CO2 sensors and others don’t), any applicable sensors should be selected in a single configuration.
4. Results: Clicking on the “Results” option at the bottom of the page will bring up a dialog box which will allow you to request the download of a Word document. Note that the processing of this document takes time – please be patient and wait for the download. If it does not download within a few minutes, there may be an issue with the system, and it should be reported.

The final edited document consists of an edited version of the ASHRAE Guideline 36, with all original document functionality maintained including active paragraph numbering, paragraph cross-references, and styles. Although paragraph numbering in the output may deviate from the original numbering in the full Guideline 36, the original paragraph numbers are noted for Level 2 headings to facilitate manual cross-referencing. Note that the document currently includes all of the informative notes within the Guideline, but instructional notes are deleted.

This document will require further review and editing prior to use on a project.

Current Coverage of Guideline 36-2021:

Supported:

• Unit System: IP, SI
• Ventilation Code: 62.1, CA Title 24
• Building Energy Code: ASHRAE 90.1, CA Title 24
• ASHRAE and California Title 24 Climate Zones
• Multiple-Zone VAV Air-Handling Unit (not including: barometric relief, relief fan with barometric damper, multiple relief fans, common relief fan inlet plenum, AFDD)
• VAV Terminal Unit – Cooling Only
• VAV Terminal Unit with Reheat

Not Supported:

• Dual-Fan Dual-Duct Heating VAV Air Handling Unit
• Single-Zone VAV Air-Handling Unit
• Fan-Powered Terminal Units
• Dual-Duct VAV Terminal Units
• Constant Speed Exhaust Fan
• Chilled Water Plant
• Hot Water Plant
• Fan Coil Unit

Note: Sequences from Guideline 36 that are not currently supported are not included in the software output.

Planned Enhancements

• User accounts and ability to save projects
• Ability to export sequences with and without informative notes
• Additional Guideline 36 sequences
• Additional sequences beyond Guideline 36
• Points lists
• Control schematics
• Control logic in CDL and CXF

Known Issues

• Once you make configure a project (units, codes, climate zone) and save it you can not make any further changes without exiting the site and re-entering.

Notes for how to use ctrl-flow

• Zone equipment configurations. Many projects will have multiple zones with varying configurations. For example some VAV reheat zones with CO2 sensors and some without. In that case, the software will only generate a single control sequence for VAV reheat zones with CO2 sensors – the output sequence will be based on the most inclusive configuration. As such, indicating all desired terminal control options in a single configuration is sufficient to generate the corresponding sequence.
• Multiple MZAHU configurations. Some projects may have multiple AHUs with different configurations. The tool can only currently provide sequences for a single AHU configuration. If control sequences are needed for different configurations, the user should define each in separate sessions with ctrl-flow, and then combine the outputted sequences manually.
• Sequences for non-supported equipment. Control sequences for other equipment that are not currently supported by ctrl-flow (e.g. chilled water plant) are not included in the output. If a project requires those sequences, they can be edited separately and manually combined with the output from ctrl-flow for supported equipment.
• Paragraph numbering.
  • The software will delete sections from Guideline 36 that are not applicable based on user selections. The paragraph numbering and paragraph references within the document are dynamic – paragraph numbering will collapse when preceding paragraphs are deleted and references other remaining paragraphs will remain intact. However, the paragraph references in the output file will need to be manually updated to display the new paragraph numbers. In Microsoft Word, type ctrl-A to select all text, then type F9 to update.
  • Note that table and figure numbers and references are not dynamic and will not change. The numbering is fixed within the Guideline 36 source file itself.
• Saving the project. There is currently no option to save a project. The tool can be used to generate a control sequence in a single session but revising the inputs at a later time may simply require starting over. Fortunately, it only takes minutes to enter the inputs.

Reporting Issues

While there has been extensive testing completed for this tool, it is still in what is considered “Beta” version – which means that you may encounter issues with the process or the tool. Your feedback is essential to the project team, and we are anxious to hear about any problems that you encounter as well as feature requests for future enhancements. If you encounter an issue, we would encourage you to report it to the project team.

Please email the following information on any issues to [email protected]:

• Operating system (PC, MAC, Other)
• Web Browser (Chrome, Firefox, Safari, etc.)
• Details on problem encountered (feel free to include multiple items in one report)