From Saturday, Nov 23rd 7:00 PM CST - Sunday, Nov 24th 7:45 AM CST, ni.com will undergo system upgrades that may result in temporary service interruption.
We appreciate your patience as we improve our online experience.
From Saturday, Nov 23rd 7:00 PM CST - Sunday, Nov 24th 7:45 AM CST, ni.com will undergo system upgrades that may result in temporary service interruption.
We appreciate your patience as we improve our online experience.
January 2022
This file contains installation instructions and compatibility information for ECU Measurement and Calibration Toolkit.
You can find more release information on ni.com.
Product Security and Critical Updates
Supported Hardware and Software
XCP/CCP Custom Device for NI VeriStand
Using NI-XNET with the ECU Measurement and Calibration Toolkit
Additional Programming Topics and Known Issues
Automating the Installation of NI Products
Using NI Software with Microsoft Windows 10
Unsupported Windows Operating Systems
The ECU Measurement and Calibration Toolkit provides full-featured APIs, plus tools for viewing ASAM A2L database files and analyzing CCP and XCP communication. The ECU Measurement and Calibration APIs enable you to develop applications that are customized to your test and simulation requirements.
ECU Measurement and Calibration Toolkit 21.5 supports the following operating systems:
Note ECU Measurement and Calibration no longer supports Windows Vista/XP/7/8.x, Windows Server 2003/2008/2012, or any 32-bit Windows operating system. ECU Measurement and Calibration 20.7 will not install or run on an unsupported OS. You cannot deploy or distribute applications that use ECU Measurement and Calibration 20.7 to an unsupported OS. Additionally, after installing ECU Measurement and Calibration 20.7, 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, visit http://www.ni.com/r/win32bitsupport.
ECU Measurement and Calibration Toolkit 21.5 supports the following application software versions, including service packs. If you are not using NI application software, refer to Microsoft Visual Studio Support.
| Application Software | Versions Supported by ECU Measurement and Calibration Toolkit 21.5 |
|---|---|
| LabVIEW | 2018 SP1, 2019 SP1, 2020 SP1, and 2021 SP1 |
| LabVIEW Real-Time Module | 2018 SP1, 2019, 2020, and 2021 |
| LabWindows™/CVI™ | 2015 and later |
| NI VeriStand | 2018 SP1, 2019 R3, and 2020 R4 |
| Microsoft Visual C/C++ | 2008 and later |
Note ECU Measurement and Calibration Toolkit software does not support LabWindows™/CVI™ Real-Time Module.
If you are using the ECU Measurement and Calibration .NET Class Library, .NET Framework 4.0 (minimum) is required. The ECU Measurement and Calibration .NET Class Library can be used with Visual C# or Visual Basic .NET in any Visual Studio version that can target .NET Framework 4.0 or .NET Framework 4.5.
To use the .NET API, you must install the .NET class libraries or the .NET wrapper in addition to the NI device driver. For information about versions of the .NET Framework and the drivers each supports, as well as the download location of the installer files, refer to NI .NET Support.
Download the ECU Measurement and Calibration 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 NI Package Manager.
Notes
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.
The following list details the hardware models supported in ECU Measurement and Calibration Toolkit 21.5.
1 You can address NI-XNET Automotive Ethernet devices using their assigned IP addresses. To use a specific interface name (e.g., ENET1) together with a custom IP configuration, you can use an XNET IP Stack from ECUMC. The IP Stack feature requires NI-XNET 20.1 or later.
Note ECU Measurement and Calibration Toolkit software supports only NI Automotive Ethernet and CAN hardware products. For information about software for Automotive Ethernet and CAN hardware products from other vendors, refer to the documentation you received with those products.
Refer to the ECU Measurement and Calibration Toolkit Help, accessible from \Users\Public\Documents\National Instruments\ECU Measurement and Calibration Toolkit\Documentation, for information about ECU Measurement and Calibration.
The help includes an introduction to the CAN Calibration Protocol (CCP) and Measurement and Calibration Protocol (XCP). It also explains how to get started with application development and includes a complete reference for all ECU Measurement and Calibration Toolkit functions.
The ECU Measurement and Calibration Toolkit software simulates two types of ECUs. All ECU Measurement and Calibration Toolkit examples are preconfigured to communicate with the ECUMC Demo ECU XCP simulation using the ASAM 2MC XcpECU.a2l file.
Most of the examples can be used with the ECUMC Demo ECU CCP simulation. In that case, please, use the CCPECU.A2L file and the related protocol token "CCP:CANx".
LabVIEW users can find the ECU simulators, seedkey DLLs, and corresponding A2L files at <National Instruments>\<LabVIEW xxxx>\examples\ECUMC. Please, use the "XCPECU.llb\ECUMC Demo ECU XCP.vi" or "CCPECU.llb\ECUMC Demo ECU CCP.vi".
Microsoft Visual C/C++ and LabWindows/CVI users can find the ECUMC Demo ECU simulators (only 32-bit), seedkey DLLs, and corresponding A2L files at
LabWindows/CVI users may refer to copies of the A2L files and seedkey DLLs provided within the CVI examples folder.
Refer to the XCP/CCP Custom Device online help for information about using the NI XCP/CCP Custom Device with VeriStand.
Upgrade Note: If you are upgrading your XCP/CCP Custom Device from the already-installed NI Developer Zone download, you need to clear the XCP/CCP controls from the NI VeriStand project temporary screen files directory. VeriStand projects created with an older VeriStand version must be converted to the new version by loading the project in System Explorer and saving it. When loading an older project into a newer VeriStand revision, a message shows up informing about missing Driver VI files. This message can be ignored and skipped.
Upgrading Existing VeriStand System Definitions from a Previous Custom Device Version: You must migrate system definitions created with an earlier version of the XCP/CCP custom device to the current version before you can use them. Therefore, open and save the system definition file in the System Explorer.
The CCP/XCP on CAN communication introduces higher busloads on the CAN network: If you are using CCP or XCP on CAN, the NI VeriStand Custom Device can add flexible configurations for reading and writing Characteristics and Measurements from the ECU. It is allowed running multiple Characteristic as well as Measurement read or write tasks in parallel. If you set up such a complex system, every task introduces some amount of busload onto the CAN network, because those CCP/XCP commands are based on a handshake protocol. If you run the CCP/XCP on CAN a protocol to its limits, the introduced busload on the CAN network increases significantly, and the ECU may not respond in the predefined time anymore. The reason is that there may not be enough free network bandwidth. In such cases, we recommended analyzing the CAN busload on the CAN network and trying to keep CAN traffic below values of 60% to 70%, to keep the network in an operable state. A typical indicator of running into such CCP/XCP on CAN protocol limits is a timeout error when executing a Characteristic/Measurement read or write operation. Therefore, we recommend checking the XCP/CCP Custom Device error status variable, whether the error 0xFFFB67FE "A timeout occurred waiting for a response from the ECU" occurs.
To use the ECU Measurement and Calibration Toolkit on a LabVIEW RT system, you must download your ASAM 2MC database (*.A2L) file to the RT target. The LabVIEW Real-Time Engine running on a PXI or CompactRIO system supports a File Transfer Protocol (FTP) server. You can access the LabVIEW RT target FTP server using any standard FTP utility for transferring files to and from the hard drive. For further information about how to download your A2L file to the RT target, refer to LabVIEW Real-Time (RT) Configuration in the ECU Measurement and Calibration Toolkit Help.
If you are using NI hardware that is supported by NI-XNET, it is recommended that you use NI-XNET 19.5 or later with this version of ECU Measurement and Calibration Toolkit.
CAN FD features are only supported with NI-XNET version 17.0.1 or later.
NI does not recommend cRIO-901x and cRIO-902x targets for CAN FD.
Custom baud rate for CAN in NI VeriStand is only supported with NI-XNET version 18.0 or later.
ECU Measurement and Calibration Toolkit 18.5 supports CCP Version 2.1.
ECU Measurement and Calibration Toolkit 18.5 does support symbolic conversion tables for reading only. Refer to mcDoubleToText for further information.
NI-I/O Trace monitors function calls to the ECU Measurement and Calibration Toolkit API. This tool helps in debugging programming problems in the application. To launch this tool, open Tools in MAX, and select NI-I/O Trace. If more than one NI driver is installed on your computer, you can specify which APIs to trace at any time. By default, all installed APIs are enabled. To select the APIs to trace, select Tools»Options, select the View Selections tab, and select the APIs under Installed API Choices.
The following LabVIEW example VIs do not run under LabVIEW Real-Time and LabVIEW Base Development System:
To make these examples run, remove the subVI call from 3DDisplayWrapper.vi in MCCharacteristicsEditors.llb.
If you are using an NI USB-8473 or NI USB-8473s, the ECU Measurement and Calibration Toolkit is based internally on the NI-CAN Frame API. For this reason, the following properties are not available for the GetProperty function:
The LabVIEW project examples for CompactRIO and R-Series are configured for use with NI 985x C-Series only.
The ECU Measurement and Calibration ECU Simulators (ECU MC Demo ECU XCP or CCP) are not supported under CompactRIO.
The Basic Examples and some advanced examples are not supported under cRIO using XCP/TCP and XCP/UDP. To use these examples, you need to modify the communication parameters such as the IP Address.
The behavior of mcDAQListInitialize has changed. It now returns an error (NoMoreDAQLists) if the requested DAQ list cannot be assigned. Prior to this change, ECU MC attempted to automatically assign a different DAQ list, but the new DAQ list might have different properties than the requested one and thus cause undesired behavior.
Property DAQ:XCP:Meas Split Allowed was moved to ECU:XCP:Meas Split Allowed in the Set Property and Get Property VIs. Existing VIs that use this property will continue to work without any changes.
XCP supports only DAQ that has a CAN identifier of DTO_ID.
The following ASAM MCD-2MC (A2L) database features are not supported:
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.
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.
ECU Measurement and Calibration 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 http://www.ni.com/r/win32bitsupport.
Copyright
© 2009–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:
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.
377542H-01