NI Electric Motor Simulation Toolkit 2016 Readme

October 2016


This file contains important information about the NI Electric Motor Simulation Toolkit, including installation instructions, recommended hardware, activating instructions, and known issues.


Overview

System Requirements

Supported Operating Systems

Installation Instructions

NI Software Support for Microsoft Windows 7, Windows Vista, Windows XP, and Windows Server 2003

Product Security and Critical Updates

Activating the Software

Recommended Hardware

Known Issues

Accessing the Help

Finding Examples

Automating the Installation of NI Products

Using NI Software with Microsoft Windows 10

Using NI Software with Microsoft Windows 8.1

Legal Information


Overview

The Electric Motor Simulation Toolkit is an add-on for both the LabVIEW platform and NI VeriStand. This toolkit provides LabVIEW VIs and sample projects to help you control and simulate an electric motor by writing your own applications. This toolkit also extends the functionality of VeriStand by providing a series of custom devices for you to design and implement a real-time motor simulation application. This toolkit uses field-programmable gate array (FPGA) technology and integrates the finite element analysis (FEA) method to provide high-speed and high-fidelity electric motor simulation.


This toolkit provides built-in examples of JMAG RTT files and ANSYS motor model files for motor simulation. You can use the RTT files or the ANSYS motor model files with the examples, sample projects, or custom devices. To configure the controller and simulator and use the built-in RTT files or ANSYS motor model files, refer to the NI website for more information.


System Requirements

In addition to the system requirements for the LabVIEW Development System, the Electric Motor Simulation Toolkit has the following requirements for LabVIEW support:


  • LabVIEW 2016 Full or Professional Development System (32-bit)
  • LabVIEW 2016 Real-Time Module
  • LabVIEW 2016 FPGA Module
  • LabVIEW 2016 Control Design and Simulation Module
  • FlexRIO Support 16.0
  • NI CompactRIO Device Drivers August 2016
  • NI R Series Multifunction RIO Device Drivers August 2016
  • At least 256 MB of disk space

Refer to the LabVIEW Readme for additional system requirements and supported operating systems for LabVIEW 2016.


For VeriStand support, the Electric Motor Simulation Toolkit has the following requirements:


  • VeriStand 2016
  • FlexRIO Support 16.0
  • NI CompactRIO Device Drivers August 2016
  • NI R Series Multifunction RIO Device Drivers August 2016
  • At least 256 MB of disk space

Refer to the NI VeriStand Readme for additional system requirements and supported operating systems for VeriStand 2016.


Installation Instructions

Double-click the setup.exe file in the root directory of the Electric Motor Simulation Toolkit installer and follow the instructions on the screen to install this product.


NI Electric Motor Simulation Toolkit 2016 Drops Support for Microsoft Windows 7 RTM, Windows Vista, Windows XP, and Windows Server 2003

With this release, NI Electric Motor Simulation Toolkit drops support for Microsoft Windows 7 RTM (with no service pack), Windows Vista, Windows XP, and Windows Server 2003. NI Electric Motor Simulation Toolkit 2016 and later will not install or run on an unsupported OS. You cannot deploy or distribute applications that use NI Electric Motor Simulation Toolkit 2016 to an unsupported OS. Additionally, after installing NI Electric Motor Simulation Toolkit 2016, you cannot use any installers built on this computer with any version of LabVIEW, LabWindows™/CVI™, NI TestStand™, or Measurement Studio on an unsupported OS.


For more information about the changes to our OS support for 2016, refer to KB 79UC78LS, Why Does my LabVIEW, LabWindows/CVI, Measurement Studio, or TestStand Built Installer Fail on Windows XP/Vista and Server 2003?.


Supported Operating Systems

The Electric Motor Simulation Toolkit supports the following operating systems:


  • Windows 10/8.11/7 SP12
  • Windows Embedded Standard 7 SP12
  • Windows Server 2012 R21
  • Windows Server 2008 R2 SP12

1 NI software installs VC2015 Runtime and .NET 4.6.1. Windows 8.1 and Windows Server 2012 R2 require Microsoft updates to support these items. Refer to Microsoft KB2919442 and KB2919355 for more information about how to install these updates.


2 NI software is signed with a SHA-256 certificate. Windows 7 SP1, Windows Embedded Standard 7 SP1, and Windows Server 2008 R2 SP1 require Microsoft updates to support SHA-256. Refer to Microsoft KB3033929 for more information about how to install this security update.


Product Security and Critical Updates

Visit ni.com/security to view and subscribe to receive security notifications about NI products. Visit ni.com/critical-updates for information about critical updates from NI.


Activating the Software

For LabVIEW support, you evaluate and activate the Electric Motor Simulation Toolkit the same as activating LabVIEW. Refer to the LabVIEW Help for more information about activating your software.


For VeriStand support, complete the following steps to activate the Electric Motor Simulation Toolkit:


  1. Launch NI License Manager by selecting Start»All Programs»National Instruments»NI License Manager or from NI Launcher in Windows 8.x.
  2. In the NI License Manager tree, navigate to the Electric Motor Simulation Toolkit in the Local Licenses»LabVIEW 2016»Toolkits folder.
  3. Double-click the toolkit name or right-click the toolkit and select Activate from the shortcut menu.
  4. In the NI Activation Wizard that appears, select Apply one or more 20-character activation codes previously acquired for this computer and click the Next button.
  5. Enter the activation code and click the Next button. The activation code is the serial number on the product packing slip or on the shipping label.
  6. Check the activation status of this toolkit in the NI License Manager.
Note  If you installed the Electric Motor Simulation Toolkit with a serial number, the Activation Wizard launches after the installation is complete. You can complete step 4-6 to activate the toolkit.

Recommended Hardware

NI recommends the following hardware for you to use with this toolkit.


ModelSimulating on RTSimulating on FPGA
ACIM Constant Parameter ModelNI PXIe-8135 RTNI PXI-7854R
PMSM Constant Parameter ModelNI PXIe-8135 RTNI PXI-7854R
PMSM Variable Parameter ModelNI PXIe-8135 RTNI PXI-7854R
PMSM FEA ModelNI PXIe-8135 RTNI PXIe-7966R + HKS-9609 by Keisokugiken Corporation (KGC)
Note  You can use NI PXIe-7965R for simulating on an FPGA target. However, when you compile the FPGA code, you must set the frequency of Top-Level Clock on the FPGA target to 80 MHz or less. Otherwise, LabVIEW fails to compile the FPGA bitfile.
SRM Linear ModelNI PXIe-8135 RTNI PXI-7854R
SRM FEA ModelNI PXIe-8135 RTNI PXIe-7965R/7966R + HKS-9609 by Keisokugiken Corporation (KGC)

Known Issues

You can access the software and documentation known issues list online. Refer to the NI website for an up-to-date list of known issues in the Electric Motor Simulation Toolkit.


Accessing the Help

Refer to the LabVIEW Help, accessible by selecting Help»LabVIEW Help from LabVIEW, for information about the Electric Motor Simulation Toolkit. You can find help information about this toolkit in the Toolkits»Electric Motor Simulation Toolkit book on the Contents tab.


Refer to the NI VeriStand Help, accessible by selecting Help»Search the NI VeriStand Help from VeriStand, for information about the Electric Motor Simulation custom devices.


Finding Examples

Select Help»Find Examples from LabVIEW to launch the NI Example Finder. Navigate to the Toolkits and Modules»Electric Motor Simulation folder to access the examples. 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.


You also can find examples for the Electric Motor Simulation Toolkit in the labview\examples\Electric Motor Simulation directory.


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. However, starting with the August 2012 releases (products using NI Installers version 3.1 or later), you may need to perform additional steps before or during a silent installation of NI software.


If the NI product you are installing uses Microsoft .NET 4.0, 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.0 separately before you install NI software.


For more information about automating the installation of NI products, refer to the following KnowledgeBase articles:


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, visit ni.com/windows10.


Using NI Software with Microsoft Windows 8.1

When you install NI software on Microsoft Windows 8.1, you will notice a few additional tiles in the Apps view, including shortcuts to NI application software products such as NI LabVIEW, Measurement & Automation Explorer (NI MAX), and NI Launcher. For more information about NI support for Windows 8.1, visit ni.com/windows8.



Legal Information

Copyright


© 2013–2016 National Instruments. 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.


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.


375059C-01