Skip to content

PotLabs/Module-project-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LabVIEW/TestStand Test Bench Module Template

This repository serves as a reusable template for creating modular LabVIEW and TestStand components used in automated test bench systems. It provides a standardized folder structure, example configurations, and reusable scripts to accelerate module development and ensure consistency across projects.


📁 Repository Structure

.
├── Analyzer/      # Tools for analyzing logs, results, or performance  
├── Build/         # Compiled binaries, packed libraries, or build outputs  
├── Code/          # Source code (VIs, sequences, CVI modules, etc.)  
├── Config/        # Configuration files (station, test sequences, instruments, etc.)  
├── Doc/           # Documentation (architecture, user guides, design notes)  
├── Examples/      # Example usages or demo scripts  
├── Img/           # Images for documentation or UI screenshots  
├── Libs/          # Third-party or internal reusable libraries  
├── Tests/         # Unit tests, integration tests, or validation scripts  
├── seq/           # TestStand sequence files  
├── LICENSE        # License file (default: MIT)  
├── project.lvproj # LabVIEW project file  
└── README.md      # Project overview and instructions  

🧰 Features

  • Modular and scalable structure
  • Predefined folders for code, documentation, and tests
  • Example TestStand sequence support
  • Integration with reusable LabVIEW/CVI libraries
  • Template support for configuration management

🚀 Getting Started

  1. Use as Template
    Click the Use this template button on GitHub to create a new repository based on this structure.

  2. Clone Your New Repository

git clone https://github.com/your-username/your-new-repo.git
  1. Start Development
    • Add your VIs or sequences in the Code/ folder.
    • Configure your test bench in the Config/ folder.
    • Document your changes in the Doc/ folder.

🧪 Testing

Place unit or integration tests in the Tests/ folder. You may also include:

  • Simulation test VIs
  • NI TestStand test sequences for validation
  • Automated regression tests

📸 Documentation & UI

Use the Doc/ folder for markdown/PDF documentation. Store UI screenshots, diagrams, and images in Img/.


📄 License

This template is licensed under the MIT License.


🧩 Recommended Tools

  • NI LabVIEW
  • NI TestStand
  • LabWindows/CVI (optional)
  • TDMS Viewer or Excel for analyzing test data
  • Git/GitHub for version control

🔧 Maintainers

Created and maintained by Abdelhakim Faddaoui and contributors.
Feel free to submit pull requests, issues, or feature suggestions.