DCAF <Module Name> Module Documentation

[Christian_L]

<Sections marked as [Optional] may be omitted/deleted if not applicable to module in question>

Overview

<short description of what the module does and what it should be used for - intended use case(s)>

Description

<longer description of what the module does and what it may be used for, include background information on peripheral technologies, protocols, implementations, etc. can link ot other content for supporting information, include diagrams>

Configuration of the <module name> Module

<describe how the module needs to be configured inside of the DCAF Editor, include any other configuration or setup information that may need to be done outside of DCAF, such as setting up a LV project before sucking the configuration into DCAF>

<inlude screenshots of the configuration editor>

<if the module doesn't already have tip strip and documentation for each control in the code, this is a good opportunity to add the required information there instead, this section could then be partially auto-generated>

[Optional] Steps before Configuration

<things you need to do before you can configure the module in the editor, e.g. UI module -build UI to interact with code>

[Optional] Using the <module name> Module

<describe how to use the module if the developer needs to do something outside of DCAF, such as consuming/providing data, e.g. using CVT outside of DCAF>

---

[Optional] Source Code Design

<Describe the implementation of the module source including information about design decisions and code that may not be intuitive/self documenting. Think about where the user might want to make changes/customizations and highlight such areas for improvement. Include diagrams.>

---

[Optional] Quality

<provide information about the level of quality of the module, how often it has been used, number of revisions>

<information about testing and validation of module>

[Optional] Benchmarks

<include specific vipc build number as this information may go out of date over time>

<Information about performance benchmarks for the module>

<Link to benchmarking code, information to reproduce benchmarks>

<need to define generic benchmarks, e.g. number of channels to execution speed of module, jitter, RTETT benchmarks>

Software Requirements

• LabVIEW <oldest version supported>
• Other modules, packages, toolkits, drivers

[Optional] Hardware Requirements

• Platform, modules, etc.
• Industr. Comm interfaces, etc.

[Optional] Limitations

• Information about limitations such as data types supported
• OSs supported
• etc.

Installation

Install the <module name> module directly from VI Package Manager: <add VIPM link>

Support

<Post issues on GituHub and ask questions below.>

Visit Collaborating on the Development of DCAF to learn how to contribute your own improvements to this module directly.