Version 14.0.0
December 2014
This file contains important information about the NI Electric Motor Simulation Toolkit, including installation instructions, new features, behavior changes, recommended hardware, activating instructions, a partial list of bugs fixed for 2014, and known issues.
Product Security and Critical Updates
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
The Electric Motor Simulation Toolkit is an add-on for both the LabVIEW platform and NI VeriStand. The toolkit provides LabVIEW VIs and sample projects to help you control and simulate an electric motor by writing your own applications. The toolkit also extends the functionality of NI 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.
The toolkit provides built-in examples of JMAG RTT files for motor simulation. You can use the RTT files with the examples, sample projects, or custom devices. To configure the controller and simulator and use the built-in RTT files, refer to the National Instruments website for more information.
In addition to the system requirements for the LabVIEW Development System, the Electric Motor Simulation Toolkit has the following requirements for LabVIEW support:
Refer to the LabVIEW Readme for additional system requirements and supported operating systems for LabVIEW 2014.
For NI VeriStand support, the Electric Motor Simulation Toolkit has the following requirements:
Refer to the NI VeriStand Readme for additional system requirements and supported operating systems for NI VeriStand 2014.
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.
Visit ni.com/security to view and subscribe to receive security notifications about National Instruments products. Visit ni.com/critical-updates for information about critical updates from National Instruments.
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 NI VeriStand support, complete the following steps to activate the Electric Motor Simulation Toolkit.
National Instruments recommends the following hardware for you to use with this toolkit.
| Model | Simulating on RT | Simulating on FPGA | |
|---|---|---|---|
| ACIM Constant Parameter Model | NI PXIe-8135 RT | NI PXI-7854R | |
| PMSM Constant Parameter Model | NI PXIe-8135 RT | NI PXI-7854R | |
| PMSM Variable Parameter Model | NI PXIe-8135 RT | NI PXI-7854R | |
| PMSM FEA Model | NI PXIe-8135 RT | NI PXIe-7966R + HKS-9609 by Keisokugiken Corporation (KGC)
| |
| SRM Linear Model | NI PXIe-8135 RT | NI PXI-7854R | |
| SRM FEA Model | NI PXIe-8135 RT | NI PXIe-7965R/7966R + HKS-9609 by Keisokugiken Corporation (KGC) |
The Electric Motor Simulation Toolkit 2014 introduces the following new features and enhancements.
You can simulate an AC induction motor (ACIM) with the constant parameter model and integrate the ACIM into your own hardware-in-the-loop (HIL) solution. ACIM is the most common motor in motion control systems. Main advantages of ACIM are simple and rugged design, low cost, and low maintenance. The Electric Motor Simulation Toolkit provides VIs, examples, sample projects, and custom devices for you to simulate an ACIM.
You can use the variable parameter model to simulate a permanent magnet synchronous motor (PMSM) with medium fidelity. The variable parameter model uses the d-q axes mathematical method to simulate an electric motor. The variable parameter model can obtain real motor characteristics either from the RTT files or from an external model. The Electric Motor Simulation Toolkit provides VIs, examples, sample projects, and custom devices to help you to simulate a PMSM and integrate the PMSM into your hardware-in-the-loop (HIL) solution.
You can simulate an inverter with the advanced three-phase inverter model. The advanced three-phase inverter model simulates the transient behavior of the inverter. By using the advanced three-phase inverter model, you can specify the forward voltage drops of the inverter switches and insert fault to the inverter at run time.
You can perform the temperature correction functionality for ACIM constant parameter model simulation, PMSM FEA model simulation, and PMSM variable parameter model simulation. By using the temperature correction functionality, you can simulate the changes of resistance, magnet flux, or torque in an electric motor according to temperature variations.
The Electric Motor Simulation Toolkit includes the following new VIs.
On the AC Induction Motor VIs palette:
On the Permanent Magnet Synchronous Motor VIs palette:
On the Inverter VIs palette:
On the Transforms VIs palette:
The Electric Motor Simulation Toolkit provides the following new examples.
You can use the following new examples to simulate an ACIM:
You can use the following new examples to simulate a PMSM:
You can use the following new examples to simulate a switched reluctance motor (SRM):
Select File»Create Project from LabVIEW to launch the Create Project dialog box. Select Motor Simulation from the Sample Projects category list to access the sample projects.
The toolkit provides the following new sample projects for you to simulate an ACIM with the constant parameter model.
The toolkit provides the following new sample projects for you to simulate a PMSM with the variable parameter model.
To access the Electric Motor Simulation custom devices in your NI VeriStand project, open the System Explorer window, navigate to Targets»Controller»Custom Devices, right-click Custom Devices, and select a custom device for electric motor simulation from the shortcut menu.
The toolkit provides the following new custom devices for you to design and implement real-time motor simulation applications.
The Electric Motor Simulation Toolkit 2014 introduces the following behavior changes.
The Electric Motor Simulation Toolkit 2014 includes the following changes to VIs.
The Electric Motor Simulation Toolkit 2014 includes the following improvements on the simulation rate.
You can access the software and documentation known issues list online. Refer to the National Instruments website for an up-to-date list of known issues in the Electric Motor Simulation Toolkit.
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 |
|---|---|
| 426911 | EM-Sim only supports one resistance for all phases currently. |
| 431695 | The TDMS file created by EM-Sim VeriStand add-on produces error when opened in DIAdem. |
| 433640 | There is no documentation for selecting a proper base value for per-unit calculations. |
| 473399 | Equations for d voltage and q voltage in Constant Parameter Model topic are incorrect. |
| 480428 | The ideal inverter model should return 0V voltage when all gate signals are False. |
| 480429 | The PMSM FEA model custom device should return 0A current when the motor controller is not present. |
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 NI VeriStand, for information about the Electric Motor Simulation custom devices.
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.
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:
When you install National Instruments 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.
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. |
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 Application | Icon Location | Pin to Action |
|---|---|---|
| Windows 8.x Desktop | Desktop Taskbar | Right-click application and select Pin to Taskbar |
| Windows 8.x Desktop | Start screen | Right-click application and select Pin to Start |
| Windows 8.x Start screen | Desktop Taskbar | Right-click application and select Pin to taskbar from the menu bar on the bottom of the screen |
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.
National Instruments 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 |
|---|---|
| NI LabVIEW | lifecycle |
| NI LabWindows™/CVI™ | cvi_lifecycle |
| NI Measurement Studio | mstudiolifecycle |
| NI TestStand | tslcp |
| NI DIAdem | ddlcp |
| NI SignalExpress | selcp |
| NI VeriStand | nivslifecycle |
Copyright
© 2013–2014 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.
National Instruments 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:
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 National Instruments trademarks. Other product and company names mentioned herein are trademarks or trade names of their respective companies.
Patents
For patents covering the National Instruments products/technology, refer to the appropriate location: Help»Patents in your software, the patents.txt file on your media, or the National Instruments Patent Notice at ni.com/patents.
375059A-01