Custom Device VIs Are Broken when Upgrading Custom Device to New VeriStand Version

Issue Details

I have custom device code that was working in a previous version of VeriStand but now need to upgrade it to work in a newer version. I can open the source code in the newer version of LabVIEW, but when I build the custom device source distribution, I get errors that a VI broke during the build process and the libraries are not built.

Solution

This error can occur if the custom device code is trying to load a different version of the VeriStand .NET APIs than what you have installed on your computer. For example, some custom device projects included a .config file that forces LabVIEW to use a specific .NET library version. This was required on some machines that had multiple versions of VeriStand installed, but should generally not be required for most customers.

To fix this errors:

1. Make sure LabVIEW is completely closed
2. Open the directory that contains the LabVIEW project for your custom device source code
3. See if a *.lvproj.config file exists in this location. For example, here you can see a .lvproj.config file for each of the LabVIEW projects for the Control Addon Custom Device:
   
   
   
   
4. If you know that you only have one version of VeriStand installed on the computer, delete these .lvproj.config files and move to Step 6. Otherwise, continue to Step 5.
5. If you have multiple versions of VeriStand installed on the computer, you may need to keep the .lvproj.config file but update it to specify the correct API version.
   • See the list of API versions corresponding to different VeriStand versions in the Additional Information below to locate the correct API version
   • Back in the custom device source directory, open the [custom device name].lvproj.config file in a text editor
   • Replace the newVersion tag value for each of the listed Assemblies with the correct API version:
     
     
     
     
   • Save and close the .lvproj.config file
     
     
6. After making these changes, reopen LabVIEW and open the custom device project

Note: Due to a LabVIEW bug, even after deleting or updating the .lvproj.config file, you may still have broken VIs in the custom device code. This can be fixed by forcing LabVIEW to recompile broken VIs, which should fix the linkages to the correct assemblies:

7. Open the custom device source project in LabVIEW
8. Open one of the custom device VIs, such as the RT Driver VI in the Engine Library or the Initialization VI in the Configuration library
9. Hold CTRL+Shift and click the VI Run Array. This will force recompile the VI
10. Save and close the VI
11. Repeat for other custom device VIs that are showing a broken run arrow
12. Once all VIs are no longer broken, rebuild the custom device source distributions

Additional Information

VeriStand .NET Assembly versions: