Skip to content

LabVIEW framework to develop InstrumentStudio plug-ins. The repo includes an example InstrumentStudio plug-in and a generator to start developing new InstrumentStudio plug-ins.

License

Notifications You must be signed in to change notification settings

ni/instrumentstudio-plugin-labview

Repository files navigation

InstrumentStudio Plug-In for LabVIEW


Introduction

The InstrumentStudio Plug-In SDK for LabVIEW allows users to host LabVIEW applications directly within the InstrumentStudio environment. This integration enables users to leverage the functionality of the InstrumentStudio soft front panel to interact with LabVIEW applications tailored to their specific needs.


Software support

NI Packages Dependency Version Required
LabVIEW (64-bit) 2021 SP1 or later
InstrumentStudio 2023 Q4 or later
JKI VI Package Manager 2021 SP1 or later
VIPM Packages Dependency Version Required
JDP Science Common Utilities 1.4.1.18 or later
JSONtext 1.8.2.122 or later

Installation

  • Download the InstrumentStudio Plug-In SDK and InstrumentStudio Plug-In SDK Generator packages from the latest release assets.

  • Install the InstrumentStudio Plug-In SDK, followed by the InstrumentStudio Plug-In SDK Generator.


Developing and deploying a LabVIEW InstrumentStudio plug-in

Refer to the InstrumentStudio Plug-In SDK Generator Guide to develop and deploy an InstrumentStudio Plug-In using the InstrumentStudio Plug-In generator tool.


Using a LabVIEW InstrumentStudio plug-in in InstrumentStudio

  1. Open InstrumentStudio and click Manual Layout.

  2. The InstrumentStudio plug-in will be listed under the Add-Ons category within the group specified in the .gplugindata file.

  3. Choose the desired plug-in and create a large panel.

    Edit Layout

  4. The layout will be populated with the plug-in UI as shown below.

    Plug-In SFP

  5. Modify the inputs in the UI to interact with the application.


Creating a package or installer to deploy a LabVIEW InstrumentStudio plug-in

  1. Open the LabVIEW project which contains the InstrumentStudio plug-in.

  2. Create a Package or Installer build specification in the project. Refer to Creating Build Specifications for more information.

    Package or Installer build spec creation

  3. Open the Destinations page in the package or installer build specification properties.

  4. Set the destination directory to C:\Program Files\National Instruments\InstrumentStudio\Addons\<Plug-in Name>.

    Destination directory

  5. In the Source Files page, add the PPL build specification of the plug-in to the destination view. This action will automatically incorporate the files generated by the PPL into the package or installer during the build process.

    Source Files

  6. To build the package or installer, right-click on the desired build specification and choose 'Build'.

    Note: The PPL build specification must be built first in order for the package or installer build to succeed.


Examples

The examples directory contains the Game of Life InstrumentStudio plug-in example. Refer to the example's README.md file for more information.


Note

About

LabVIEW framework to develop InstrumentStudio plug-ins. The repo includes an example InstrumentStudio plug-in and a generator to start developing new InstrumentStudio plug-ins.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •