April 2020
This file contains information about the ECU Measurement and Calibration Toolkit software.
Supported Software and Hardware
Additional Programming Topics and Known Issues
Additional Topics and Known Issues for use of XCP/CCP Custom Device for NI VeriStand
Automating the Installation of NI Products
Using NI Software with Microsoft Windows 10
Using NI Software with Microsoft Windows 8.1
Using NI-XNET with the ECU Measurement and Calibration Toolkit
The ECU Measurement and Calibration Toolkit provides full-featured APIs, plus tools for configuration and analysis. 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 20.0 supports the following operating systems:
1 NI software installs VC2015 Runtime and .NET 4.6.2. 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 and KB3125574 for more information about how to install these updates.
Note In 2016 National Instruments dropped support for Windows Vista, Windows XP, Windows Server 2003, and installations of Windows 7 without any service packs. ECU Measurement and Calibration Toolkit will not install or run on an unsupported OS. You cannot deploy or distribute applications that use ECU Measurement and Calibration Toolkit to an unsupported OS. Additionally, after installing this version of ECU Measurement and Calibration Toolkit, 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, refer to KB 79UC78LS, NI Installer Fails on Windows XP/Vista and Windows Server 2003.
Note Support for Windows 32-bit operating systems may require disabling physical address extension (PAE). To understand how this might affect your system and what actions you might need to take, refer to NI Software Fails When Physical Address Extension is Enabled.
NI Software will drop support for Phar Lap ETS Real-Time Operating System starting in 2022. Versions of this product that ship after May 1, 2022, may not install or execute correctly on this operating system. For high-level information on the support roadmap for Phar Lap and its replacement, NI Linux Real-Time, please visit ni.com/r/xf35k1. To find out what hardware is supported on PXI controllers running NI Linux Real-Time, please visit ni.com/r/b7g5wi.
This version of the ECU Measurement and Calibration Toolkit supports the following application software versions, including service packs.
| Application Software | Versions Supported by ECU Measurement and Calibration Toolkit 20.0 |
|---|---|
| LabVIEW | 2017, 2018, 2019, and 2020 |
| LabVIEW Real-Time Module | 2017, 2018, 2019, and 2020 |
| LabWindows™/CVI™ | 2015 and later |
| NI VeriStand | 2017, 2018, 2019, and 2020 |
| Microsoft Visual C/C++ | 2008 and later |
Note The ECU Measurement and Calibration Toolkit software does not support LabWindows™/CVI™ Real-Time Module.
This version of the ECU Measurement and Calibration Toolkit software supports the following software and hardware:
Note The ECU Measurement and Calibration Toolkit software supports only National Instruments 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.
Before installing the ECU Measurement and Calibration Toolkit software, log on as Administrator or as a user with Administrator privileges. The ECU Measurement and Calibration Toolkit software setup program must have Administrator privileges because the program modifies the configuration registry of your system. Complete the following steps to install the ECU Measurement and Calibration Toolkit software.
Note To download NI Package Manager, visit ni.com/info and enter the Info Code NIPMDownload. Refer to the NI Package Manager Manual for more information about installing, removing, and upgrading NI software using NI Package Manager.
MSVC and LabWindows/CVI users should always install the MSVC Support feature. This feature installs the CCP and XCP Demo ECUs, which may be helpful if you are running ECU MC MSVC and LabWindows/CVI examples.
The ECU Measurement and Calibration Toolkit software simulates ECU communication using two calibration protocols: XCP and CCP.
All of the ECU Measurement and Calibration Toolkit examples are preconfigured to communicate with the NI ECUMC Demo ECU XCP simulation using an ASAM 2MC file, XcpECU.a2l. Many of the examples can be used with the NI ECUMC Demo ECU CCP simulation. To use an example with the ECU CCP simulation, use the CCPECU.A2L file and the related protocol token, CCP:CANx.
LabVIEW users can find the ECU simulators, seed-key DLLs, and corresponding A2L files in the following path: <National Instruments>\<LabVIEW xxxx>\examples\ECUMC\
Note that the XCPECU.llb library file contains the ECUMC Demo ECU XCP VI; the CCPECU.llb library file contains the ECUMC Demo ECU CCP VI.
Microsoft Visual C/C++ and LabWindows/CVI users can find the ECUMC Demo ECU simulators (only 32-bit), seed-key DLLs, and corresponding A2L files in the following paths:
LabWindows/CVI users may refer to copies of the A2L files and seed-key DLLs provided within the CVI examples folder.
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.
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.
The ECU Measurement and Calibration Toolkit 20.0 release adds the following features:
The ECU Measurement and Calibration Toolkit 19.5 release adds the following features:
The ECU Measurement and Calibration Toolkit 19.0 release adds the following features:
The ECU Measurement and Calibration Toolkit 18.5 release adds the following features:
ECU Measurement and Calibration Toolkit supports CCP Version 2.1.
ECU Measurement and Calibration Toolkit does support symbolic conversion tables for reading only. Refer to documentation for 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, from within MAX click Tools and select NI I/O Trace. If more than one National Instruments driver is installed on your computer, you can specify which APIs to trace at any time. By default, all installed APIs are enabled. To specify APIs to trace, select Tools»Options, click the View Selections tab, and select the APIs under Installed API Choices.
The following LabVIEW examples do not run in LabVIEW Real-Time and LabVIEW Base Development System environments:
To enable these examples to run, remove the subVI call to 3DDisplayWrapper.vi in MCCharacteristicsEditors.llb. This bypasses the 3D display capability, making the editor fully functional.
If you are using a USB-8473 or USB-8473S device, 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 devices only.
The ECU Measurement and Calibration ECU Simulators (ECU MC Demo ECU XCP or CCP) are not supported under CompactRIO.
The examples in the ECUMC_Basic library, and some examples in ECUMC_Advanced are not supported under cRIO using XCP/TCP and XCP/UDP. To use these examples, you need to modify 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, ECUMC 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.
The DAQ:XCP:Meas Split Allowed property 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:
Refer to the XCP or CCP Master NI VeriStand Custom Device Help for information about using the NI XCP/CCP custom device with VeriStand.
Upgrade Note: To use a VeriStand project created with a previous version of VeriStand, you must migrate the project to your current version. To migrate, use System Explorer to open the project file, and the save the file from the current version of VeriStand. When you load an older project into a newer version of VeriStand, the program displays a message about missing Driver VI files. You can safely ignore this message.
Upgrading Existing VeriStand System Definitions from a Previous Custom Device Version: To use an XCP/CCP custom device in a System Definition from a previous version of VeriStand, you must migrate the System Definition file to your current version. Note that you must clear the XCP/CCP controls from the NI VeriStand project temporary screen files (.nivsscr or .nivsscreen) directory. To migrate, use System Explorer to open the System Definition file (.nivssdf), and then save the file from the current version of VeriStand.
CCP/XCP on CAN communication introduces higher busloads on the CAN network: The CAN Calibration Protocol (CCP) is used for communication with CAN interfaces such as ECUs. Like CCP, the Universal Measurement and Calibration Protocol (XCP) is a networking protocol used for connecting calibration systems to ECUs. While CCP is restricted to the CAN bus, XCP supports several transport layers, including CAN (XCP on CAN) and Ethernet (XCP on Ethernet). Using NI VeriStand, you can create or use existing custom devices, which enable you to simulate ECU validation and testing. In particular, VeriStand custom devices add flexible configurations for exchanging Characteristics and Measurements data with an ECU; and multiple Characteristics and Measurements read or write tasks can be run in parallel.
If you are using CCP or XCP on CAN, there are certain factors that potentially can have adverse effects on network speed and bandwidth. CCP/XCP commands are based on a handshake protocol, which involves two-way communication (read/write). On complex systems, each task (e.g., get measurements, read and write characteristics) increases the bus load on the network. Running the CCP/XCP on CAN protocol at its maximum capacity also increases the bus load on the CAN network significantly, and ECU response time can become too slow. It is recommended that you analyze the traffic load on the CAN network and try to keep CAN traffic below 60% to 70% to maintain an operable state on the network.
A typical indication that CCP/XCP on CAN protocol has reached a maximum limit is a timeout error occurring when a Characteristic/Measurement read or write operation is executed. To determine whether a timeout error has occurred, check whether the custom device has reported one of the following error codes:
The following items are a subset of issues fixed in ECU Measurement and Calibration Toolkit. If you have a Bug ID, you can search to validate that the issue has been fixed. This is not an exhaustive list of issues fixed in the current version of the ECU Measurement and Calibration Toolkit.
| Bug ID | Summary |
|---|---|
| 896103 | ECUMC does not return an error when the response to GET_DAQ_LIST_INFO command is less than the required 6 bytes |
| 898117 | GetProperty(Event Channels) function returns a random value if the name input is an empty string |
| 902352 | Internal calculation of timestamp may be inaccurate for specific ECU timestamp settings |
| 903056 | XCP and CCP call the GET_DAQ_LIST_INFO command unnecessarily |
| 903211 | DAQ List Initialize function does not verify that measurements are provided |
Refer to the ECU Measurement and Calibration Toolkit Help, accessible from Start»National Instruments»ECUMC Documentation, for more information about ECU Measurement and Calibration Toolkit.
The ECU Measurement and Calibration Toolkit Help is the primary reference document for this product. 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.
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.
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.
ECU Measurement and Calibration Toolkit will drop support for Windows 7 (32- and 64-bit), Windows Server 2008 R2, and all 32-bit Windows operating systems starting in 2021. 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 ni.com/r/win32bitsupport.
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 ECU Measurement and Calibration Toolkit.
CAN FD features are only supported with NI-XNET version 17.0.1 or later.
Custom baud rate for CAN in NI VeriStand is only supported with NI-XNET version 18.0 or later.
Copyright
© 2009–2020 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:
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.
377542E-01