LabVIEW Reference Architecture for Configuration Dialogs
Overview
This provides a framework for resizeable configuraiton dialogs that uses a plugin model for extensibility and easy customization. It simplifies the task of reading/writing configuration to disk and taking care of formatting for arbitrary data
Installation
- Run the included VIPC file to automatically download and install required dependncies, which includes:
- oglib_array
- oglib_error
- oglib_string
- oglib_lvdata
- oglib_variantconfig
- oglib_appcontrol
- oglib_file
- Open and run TESTING ONLY.vi to ensure everything is setup and loaded correctly
- If it works correctly, a blank configuration dialog should appear
- If running this vi results in the error "An error will be thrown if the configuration dialog attempts to return any message to the calling actor other than the 'Handle Last Ack,' the path is invalid.
- Change the path to a valid directory
Running example with plugins
- Navigate to /Basic Configuration Dialog and open the included project 'Config Dialog Example'
- Open 'Launch Example Dialog.vi'
- Modify the path to point to the included 'ConfigFile.ini' file in the same directory
- Run the VI
- Change settings and confirm that the ini file is modified
Adding Custom Dialogs and Config
Note: it is easiest to start from the 'Config Dialog Example' project by saving a copy and modifying the implementation.
Steps:
- Create a child class of Configuration.lvclass
- Use the private data cluster of the class to define the configuration parameters that this pane will modify
- Override methods to save/load configuraiton parameters to disk: 'Read Configuration Parameters.vi' and 'Store Configuration Parameters.vi'
- Implement method for displaying configuration dialog. Again, I HIGHLY recommend duplicating one of the examples included in the 'Example Configuration Dialog' project. They can be found in \Example Configuration Dialog.lvclass\SubPanel Displays' in the Project Tree. Note that the UI has been configured to ensure it resizes correctly Override 'Store Static VI References for Subpanel.vi' to reference the subpanel VIs you want to display and the name that should appear in the list
LabVIEW CI runs on every pull request. See the CI dashboard for build status, VI Analyzer results, VI diffs, and mass-compile reports.