LabVIEW 2021 Model Interface Toolkit Readme

February 2022

This file contains installation instructions and compatibility information for the LabVIEW Model Interface Toolkit.

You can find more release information on ni.com.


Overview

System Requirements

Supported Operating Systems

Application Software Support

Installation Instructions

Upgrade and Compatibility Issues

Accessing the Software and Help

Finding Examples

Automating the Installation of NI Products

Using NI Software with Microsoft Windows 10

Unsupported Windows Operating Systems

Legal Information


Overview

Use the LabVIEW Model Interface Toolkit to connect simulation models from a variety of simulation environments and programming languages to real-world I/O.

System Requirements

The LabVIEW Model Interface Toolkit requires the LabVIEW 2021 Full or Professional Development System (64-bit) and any system requirements for LabVIEW 2021. Refer to the LabVIEW Readme for additional system requirements and supported operating systems.

To integrate and run your existing compiled models, you only need to install the Model Interface Toolkit. To perform other tasks with models, there are additional software requirements:

Task Software Requirements
Develop a model using MathWorks Simulink® software. Install the following software as a licensed user on the host computer:
  • MathWorks MATLAB® software (64-bit).
  • MathWorks Simulink.
Compile a model developed using MathWorks Simulink. Install the following software as a licensed user on the host computer:
  • MathWorks Real-Time Workshop® (Simulink Coder®).
  • VeriStand Model Framework. Install VeriStand Model Framework as an add-on in NI Package Manager. Refer to the NI website for a list of tested and supported compilers.
Compile a LabVIEW VI into a .lvmodel or .lvmodelso file. Install VeriStand Model Generation Support for LabVIEW as a VeriStand add-on in NI Package Manager.

If you use other modeling environments, contact your vendor about requirements for developing and converting the model into a compiled model.

Supported Operating Systems

The LabVIEW Model Interface Toolkit supports the following operating systems:

Windows Systems Real-Time Targets
  • Windows 10 64-bit version 21H11
  • Windows Server 2016
  • Windows Server 2019
  • NI Linux Real-Time (Intel x64-based)2 3

1 NI software installs VC2015 Runtime and .NET 4.6.2.

2 VeriStand no longer supports Phar Lap ETS or NI Linux Real-Time (ARM-based) targets.

3 RT targets require a driver version that supports LabVIEW Real-Time Module (64-bit).

Application Software Support

The LabVIEW Model Interface Toolkit supports the following application software versions, including service packs.

Application SoftwareVersions Supported by Model Interface Toolkit
LabVIEW Full or Professional Development System (64-bit) 2021 SP1

Installation Instructions

Download the LabVIEW Model Interface Toolkit installer from ni.com/downloads. NI software includes NI Package Manager to handle the installation. Refer to the NI Package Manager Manual for more information about installing, removing, and upgrading NI software using Package Manager.

Notes

  • If Windows Update is enabled, the installation process might hang if Windows Update interferes with the installation of Microsoft Visual C++ 2015 Run-Time. Visit ni.com/r/exjq43 for more information and steps to resolve this issue.
  • If you purchased this product with an NI Software Suite or NI Product Bundle, use the installation media that shipped with your purchase to install this product.

Product Security and Critical Updates

Visit ni.com/security to view and subscribe to receive security notifications about NI products. For information about critical updates from NI, refer to Available Critical and Security Updates for NI Software.

Upgrade and Compatibility Issues

The VeriStand Model Framework contains changes to the files you use to develop and compile models in C/C++ and third-party modeling environments. If your system contains models compiled with previous versions of the Model Framework, choose from the following options for continuing to use the models in LabVIEW Model Interface Toolkit:

  • If you do not need to update your model or deploy it to Intel x64-based targets that run NI Linux Real-Time, you can continue to use the model as-is.
  • If you need to update functionality of your model that does not require the changes in the latest version of the Model Framework, you can recompile the model against the deprecated Model Framework files. These files are installed at <RootDrive>\VeriStand\version\ModelInterface\custom\src\obsolete. However, you cannot deploy the recompiled model to Intel x64-based targets that run NI Linux Real-Time.
  • To use the new features in the latest version of the Model Framework, or if you need to deploy the model to Intel x64-based targets that run NI Linux Real-Time, update and recompile the models using the 2021 version of the Model Framework. Update your models according to the following differences between new files in the Model Framework and the deprecated files they replace:
    • ni_modelframework.h contains the following differences from NIVERISTAND_API.h:
      • Implements fixed-width data types from the C99 standard, such as replacing int with int32_t where applicable.
      • Replaces use of the long data type with int32_t or uint32_t where applicable to achieve cross-platform compatibility.
    • ni_modelframework.c contains the following differences from codegen.c:
      • This file is installed on disk at <custom>\src\ni_modelframework.c rather than in the <custom> directory.
      • USER_TakeOneStep() now returns an int32_t value rather than void. If the function completes successfully, it returns NI_OK. If an error occurs, this function returns NI_ERROR.
      • The USER_ModelName global variable is a const char and replaces the ModelName variable.
      • The USER_Builder global variable is a const char and replaces the build variable.
      • The USER_BaseRate global variable is a const char and replaces the baserate variable.

Accessing the Software and Help

To access the Model Interface Toolkit VIs, select View»Functions Palette from the block diagram in LabVIEW and navigate to the Control Design & Simulation»Model Interface palette. You also can right-click any blank space on the block diagram to display the Functions palette.

Refer to the Toolkits»Model Interface Toolkit book on the Contents tab of the LabVIEW Help for more information about the Model Interface Toolkit.

Finding Examples

Select Help»Find Examples from LabVIEW to launch the NI Example Finder. LabVIEW examples for the Model Interface Toolkit are located in the labview\examples\Control and Simulation\Model Interface directory. You can modify an example VI to fit an application, or you can copy and paste from one or more examples into a VI that you create.

The example models included with the Model Framework are located at <RootDrive>\VeriStand\version\ModelInterface\custom\examples.

Automating the Installation of NI Products

You can automate the installation of most NI products using command-line arguments to suppress some or all of the installer user interface and dialog boxes.

If the NI product you are installing uses Microsoft .NET 4.6.2, the .NET installer may run before any NI software installs and may require a reboot before the installation of NI software begins. To avoid a .NET reboot, install .NET 4.6.2 separately before you install NI software.

For more information about automating the installation of NI products, refer to Automating an Installer in the NI Package Manager manual.

Using NI Software with Microsoft Windows 10

Microsoft Windows 10 is the latest version of the Windows operating system and features significant changes compared to previous versions. Windows 10 introduces several new capabilities and also combines features from both Windows 7 and Windows 8. For more information about NI support for Windows 10, refer to NI Product Compatibility for Microsoft Windows 10.

Unsupported Windows Operating Systems

LabVIEW Model Interface Toolkit no longer supports Windows Vista/XP/7/8.x, Windows Server 2003/2008/2012, or any 32-bit Windows operating system. Versions of this product that ship after May 1, 2021, may not install or execute correctly on these operating systems. For detailed information about NI operating system support, visit https://www.ni.com/r/win32bitsupport.


Legal Information

Copyright

© 2013–2022 National Instruments Corporation. All rights reserved.

Under the copyright laws, this publication may not be reproduced or transmitted in any form, electronic or mechanical, including photocopying, recording, storing in an information retrieval system, or translating, in whole or in part, without the prior written consent of National Instruments Corporation.

NI respects the intellectual property of others, and we ask our users to do the same. NI software is protected by copyright and other intellectual property laws. Where NI software may be used to reproduce software or other materials belonging to others, you may use NI software only to reproduce materials that you may reproduce in accordance with the terms of any applicable license or other legal restriction.

End-User License Agreements and Third-Party Legal Notices

You can find end-user license agreements (EULAs) and third-party legal notices in the following locations after installation:

  • Notices are located in the <National Instruments>\_Legal Information and <National Instruments> directories.
  • EULAs are located in the <National Instruments>\Shared\MDF\Legal\license directory.
  • Review <National Instruments>\_Legal Information.txt for information on including legal information in installers built with NI products.

U.S. Government Restricted Rights

If you are an agency, department, or other entity of the United States Government ("Government"), the use, duplication, reproduction, release, modification, disclosure or transfer of the technical data included in this manual is governed by the Restricted Rights provisions under Federal Acquisition Regulation 52.227-14 for civilian agencies and Defense Federal Acquisition Regulation Supplement Section 252.227-7014 and 252.227-7015 for military agencies.

IVI Foundation Copyright Notice

Content from the IVI specifications reproduced with permission from the IVI Foundation.

The IVI Foundation and its member companies make no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The IVI Foundation and its member companies shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material.

Trademarks

Refer to the NI Trademarks and Logo Guidelines at ni.com/trademarks for information on NI trademarks. Other product and company names mentioned herein are trademarks or trade names of their respective companies.

An NI Partner is a business entity independent from NI and has no agency, partnership, or joint-venture relationship with NI.

Patents

For patents covering the NI products/technology, refer to the appropriate location: Help»Patents in your software, the patents.txt file on your media, or the NI Patent Notice at ni.com/patents.

375381F-01