Creating a VIPM Package

The Virtual Package Manager (VIPM) is a tool for managing LabVIEW packages, including instrument drivers and plugins. Using VIPM, you can create a package from your LabVIEW project that can be easily shared and installed by others.

This tutorial will guide you through the process of creating a new VIPM package for use with the Rxn Rover platform.

General Steps to Create a VIPM Package

1. Open VIPM Launch the VI Package Manager application.

2. Create a New Package

   • Click the Open VI Package Builder icon in the VIPM toolbar (top-left).

   • In the Package Builder menu, select Create New.

   • Set the Source Directory to the root folder of your LabVIEW project.

   • Set the Product Name to a meaningful name (e.g., “IR Sensor Plugin”).

   • Set the Company Name to:

     • Rxn Rover if you’re a first-party developer.

     • Your own company name if you’re a third-party developer.

   This will create a new .vipb (VI Package Builder) file named after the Product Name in your project directory.

3. Configure Basic Build Information

   • Source Directory: Points to your LabVIEW project root.

   • Build Output Directory: Choose a location like <your-workspace>\VIPMPackages.

Note

The rest of the configuration differs slightly depending on whether you’re a first-party (Rxn Rover) or third-party developer.

First-Party Plugins (Rxn Rover Developers)

These instructions are for Rxn Rover developers creating official plugins or drivers.

1. Display Information

   • Product Name: Name of your plugin (e.g., “IR Sensor Plugin”).

   • Icon: Optional.

   • Company Name: Rxn Rover

   • Author Name: Rxn Rover

   • Product Homepage: https://github.com/RxnRover/<your-plugin-repo>

   • Copyright: Copyright (c) <year> RxnRover

   • License Agreement: Path to LICENSE.txt in your project folder.

   • Summary: Short description (e.g., “A plugin for IR sensor data acquisition and processing”).

2. Destinations

   • For plugins: Documents\RxnRover\Plugins\<plugin-type>\<Product Name>

   • For drivers: instr.lib\<Company Name>\<Product Name>

   • Package Filename: Use this format: rxn_rover_lib_<product_name>-X.X.X.X.vip

Continue with the rest of the tutorial at Building and Sharing the Package.

Third-Party Plugins

For external developers who wish to make their plugin compatible with Rxn Rover.

1. Display Information

   • Product Name: Name of your plugin (e.g., “IR Sensor Plugin”).

   • Icon: Optional.

   • Company Name: Your organization’s name

   • Author Name: Your personal or your organization’s name

   • Product Homepage: e.g., https://github.com/<github_username>/<your_plugin_repo.>

   • Copyright: Copyright (c) <year> <Your Company>

   • License Agreement: Path to LICENSE.txt in your project folder.

   • Summary: A brief description of the plugin.

   • Description: Provide a more detailed explanation of the plugin’s features and how to use it.

2. Destinations

   • For plugins: Documents\RxnRover\Plugins\<plugin-type>\<Product Name>

   • For drivers: instr.lib\<Company Name>\<Product Name>

Note

Keep install paths consistent with Rxn Rover’s plugin architecture to ensure compatibility.

3. Source File Settings

   • Include: - All required .vi files - Configuration files - Documentation (e.g., README.md, LICENSE.txt)

   • Exclude: .git, .gitignore, .lvproj, other unnecessary dev files.

   • Set the Package Source Destination to the install path you defined in the Destinations tab.

   • This applies to all subfolders unless explicitly overridden.

4. Package Dependencies

   • VIPM will auto-detect most dependencies.

   • Manually add:

     • RxnRover (core library)

     • Dynamic Reentrant (required for plugin loading)

     • Any other required plugins or drivers.

Important

If your plugin depends on a specific driver, be sure to include that in the dependencies.

5. Install Requirements

   • Set compatible:

     • Operating Systems

     • LabVIEW Versions

Building and Sharing the Package

1. Once configuration is complete, click Build Package in the VIPM toolbar.

2. The output .vip file will be generated in your chosen directory.

3. Run the .vip file to install and test the package using VIPM.

Share your .vip file with others or submit it to the Rxn Rover Plugin Catalog for inclusion.

Note

If any part of this tutorial feels unclear, you can explore the .vipb build files inside the Plugin examples in our Public GitHub Repositories, or start a conversation on the Rxn Rover GitHub Discussion Board.

After creating your plugin consider making a submission to the Rxn Rover Plugin Catalog