NI Electric Motor Simulation Toolkit 2015 Readme

October 2015


This file contains important information about the NI Electric Motor Simulation Toolkit, including installation instructions, new features, recommended hardware, activating instructions, a partial list of bugs fixed for 2015, and known issues.


Overview

System Requirements

Installation Instructions

Product Security and Critical Updates

Activating the Software

Recommended Hardware

New Features and Behavior Changes

Known Issues

Bug Fixes

Accessing the Help

Finding Examples

Automating the Installation of NI Products

How to Use NI Software with Microsoft Windows 8.x

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

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 2015 Full or Professional Development System (32-bit)
  • LabVIEW 2015 Real-Time Module
  • LabVIEW 2015 FPGA Module
  • LabVIEW 2015 Control Design and Simulation Module
  • FlexRIO Support 15.0
  • NI CompactRIO Device Drivers August 2015
  • NI R Series Multifunction RIO Device Drivers August 2015
  • At least 256 MB of disk space

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


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


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

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


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.


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 2015»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)

New Features and Behavior Changes

New Features

The Electric Motor Simulation Toolkit 2015 supports ANSYS motor model files (.txt) for simulating a PMSM with the variable parameter model. The Electric Motor Simulation Toolkit 2015 adds a new instance called ANSYS File to the Create PMSM Variable Parameter Model VI. You can use the ANSYS File instance to read the ANSYS motor model file to get a LabVIEW class reference of the PMSM variable parameter model.


Behavior Changes

You can use the following components in the Electric Motor Simulation Toolkit 2015 to read the ANSYS motor model file:


  • The PMSM Variable Parameter Model Closed Loop example
  • The PMSM Variable Parameter Model Control Simulation example
  • The PMSM Variable Parameter Model Simulation on Real-Time Targets sample project
  • The PMSM Variable Parameter Model Simulation on FPGA Targets sample project
  • The PMSM Variable Parameter Model Custom Device

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.


Bug Fixes

The following items are the IDs and titles of a subset of issues fixed in the Electric Motor Simulation Toolkit. This is not an exhaustive list of issues fixed in the current version of the Electric Motor Simulation Toolkit. If you have a CAR ID, you can search this list to validate that the issue has been fixed.


ID Fixed Issue
518078 The FPGA PMSM FEA model can output unexpected results
539420 The resistance input in the PMSM variable parameter model VI has no effect

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:


How to Use NI Software with Microsoft Windows 8.x

When you install NI software on Microsoft Windows 8.x, 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.


Using NI Launcher

NI Launcher helps you find and launch installed NI products. It provides you with a method of finding NI products similar to the Start menu in previous versions of Microsoft Windows. To use NI Launcher, click the NI Launcher tile in the Apps view. NI Launcher launches the desktop and opens a menu containing a list of NI products. Click any NI product to launch it.


Note  NI MAX does not appear as a desktop shortcut when installed on Microsoft Windows 8.x. You can launch NI MAX either from the Apps view or from within NI Launcher.


Pinning Frequently Used Applications

For convenience, you can pin your most-used NI applications, such as MAX, to either the Start screen or the Taskbar on the desktop, as necessary:


Current ApplicationIcon LocationPin to Action
Windows 8.x DesktopDesktop TaskbarRight-click application and select Pin to Taskbar
Windows 8.x Desktop Start screenRight-click application and select Pin to Start
Windows 8.x Start screenDesktop TaskbarRight-click application and select Pin to taskbar from the menu bar on the bottom of the screen

Finding All Programs

If you want to find a particular application or related files, such as documentation files, from the Start screen, you can access all installed files from the Apps view. To get to the Apps view, right-click anywhere on the Start screen and select All apps (Windows 8.0) or click the down arrow on the bottom left of the screen (Windows 8.1).


For more information about NI support for Windows 8.x, visit ni.com/windows8.


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

NI Electric Motor Simulation Toolkit will drop support for Microsoft Windows Vista, Windows XP, and Windows Server 2003 as of July 1, 2016. Versions of Electric Motor Simulation Toolkit that ship after July 1, 2016 will not install or run on Windows Vista, Windows XP, or Windows Server 2003. For detailed information about NI application software product life cycles, visit ni.com/info and enter one of the following Info Codes:


Product Info Code
LabVIEWlifecycle
LabWindows™/CVI™cvi_lifecycle
Measurement Studiomstudiolifecycle
TestStandtslcp
DIAdemddlcp
SignalExpressselcp
VeriStandnivslifecycle

Legal Information

Copyright


© 2013–2015 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.


375059B-01