11 Setup

Project Template

The easiest way to start a new project based on our HSE Application Template is by using the HSE Application Template Wizard. It installs a project template which you can use from LabVIEW’s “Create Project…” menu. The toolkit can be installed via VI Package Manager:

Project template for creating new projects based on the HSE Application Template: https://www.vipm.io/package/hse_lib_hse_application_template_wizard/

Semi-Manual Tool

Julian Schary has started work on a tool that automates steps 2-3. You can find it inside the repository at ''/Tools/Project Initializer/''.

Manual Process

Starting your own project based on the HSE Application Template takes only a few steps.

0. Install Dependencies

Apply the project's VI Package Configuration (.vipc) file

The .vipc file is available for download from GitLab:
hse-application-template.vipc

1. Prepare Project

get the latest release (or clone or download the code from the repository on GitLab)
extract the downloaded archive file

Beware that some libraries are included in the git repository as git submodules. Make sure that those are correctly initialised when cloning the repository. Also, be aware that submodules are not included when downloading the source code from GitLab. Download a release package from our Dokuwiki instead.

The latest release packages are available for download from our Dokuwiki:
HSE Application Template Releases

Make sure that you see a valid HSE project structure:

  /TEMPLATE_Config
      /Common
      /Unit_SomeUnitId
      config.ini.default
  /TEMPLATE_Source
      /Framework
      /Libraries
      /Modules
      /Project
      startup.vi
      TEMPLATE.lvproj

2. Rename Files

Rename all occurrences of TEMPLATE with the project name of your choice. For the sake of this example, let's assume we want our new project to be called MyNiceProject!

Rename /TEMPLATE_Config/ to /MyNiceProject_Config/
Rename /TEMPLATE_Source/ to /MyNiceProject_Source/
Rename /TEMPLATE_Source/TEMPLATE.lvproj to /MyNiceProject_Source/MyNiceProject.lvproj

3. Update LabVIEW Files

Update the block diagram constant labelled PROJECT Name in /MyNiceProject_Source/Project/PROJECT_Name–constant.vi to the value of MyNiceProject
Optionally, update the build specification inside the .lvproj to point to the folder /MyNiceProject/, which needs to sit on the same level as the /MyNiceProject_Config/ folder

4. Check Configuration

See also Configuration.

In MyNiceProject_Config/, copy the config.ini.default file to config.ini
Optionally, create a new Unit_MyNiceUnit folder (this will contain your own, private set of configuration files)
Update the MyNiceProject_Config/config.ini file to point to MyNiceUnit

HAMPEL SOFTWARE ENGINEERING

Table of Contents