Vi-Carrealtime 20.1 Installation Guide

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 17

VI-CarRealTime 20.

1 Installation Guide

www.vi-grade.com
email: info@vi-grade.com

© 2020 VI-grade GmbH


VI-CarRealTime 20.1 Installation Guide

Copyright Information

VI-grade GmbH

VI-Aircraft, VI-Animator, VI-Automotive, VI-BikeRealTime, VI-CarRealTime,


VI-Dashboard, VI-Driver, VI-DriveSim, VI-EventBuilder, VI-GraphSim, VI-MotionCueing,
VI-MotorCycle, VI-Rail, VI-Road, VI-SimSound, VI-SportsCar, VI-SuspensionGen, VI-Tire,
VI-TireLimits, VI-WorldSim

Copyright 2006-2020, VI-grade GmbH, Darmstadt, Germany.

This software contains confidential and proprietary information of VI-grade GmbH.


All rights reserved. This code may not be copied or reproduced in any form,
in part or in whole, without the explicit, prior written permission of the copyright owner.
Third-party software is copyrighted and licensed from VI-grade GmbH suppliers.

This software may include libraries licensed under LGPL terms.

Trademarks

VI-Aircraft, VI-Animator, VI-Automotive, VI-BikeRealTime, VI-CarRealTime,


VI-Dashboard, VI-Driver, VI-DriveSim, VI-EventBuilder, VI-GraphSim, VI-MotionCueing,
VI-MotorCycle, VI-Rail, VI-Road, VI-SimSound, VI-SportsCar, VI-SuspensionGen, VI-Tire,
VI-TireLimits, VI-WorldSim are trademarks of
VI-grade GmbH or of one of its subsidiaries.

Python is a registered trademark of the Python Software Foundation

All other trademarks referenced herein are property of their respective holders.

Printed: November 2020

© 2020 VI-grade GmbH


VI-CarRealTime 20.1 Installation Guide 3
Contents

Table of Contents

Part 1 Installation Guide 4


...................................................................................................................................
1 VI-CarRealTime 20.1 installation on Windows 4
How To Get The Software .......................................................................................................................................................... 4
Running the Installer .......................................................................................................................................................... 5
Standard Installation .......................................................................................................................................................... 6
Components ......................................................................................................................................................... 6
Installation Folder ......................................................................................................................................................... 7
Installing ......................................................................................................................................................... 7
Network Installation .......................................................................................................................................................... 9
Installation Folder ......................................................................................................................................................... 9
Installing ......................................................................................................................................................... 10
Batch Installation .......................................................................................................................................................... 11
Uninstalling .......................................................................................................................................................... 11
2 Setting up the License ................................................................................................................................... 12
3 Troubleshooting ................................................................................................................................... 13
4 License Toolkit ................................................................................................................................... 15

© 2020 VI-grade GmbH


4 VI-CarRealTime 20.1 Installation Guide
Installation Guide

1 Installation Guide

1.1 VI-CarRealTime 20.1 installation on Windows


Welcome to the installation guide for VI-CarRealTime 20.1.

The following topics are available:


· How To Get The Software
· Running the Installer
· Server Installation
· Client Installation
· Batch Installation
· Uninstalling

1.1.1 How To Get The Software


In order to perform an installation of VI-CarRealTime, you need to pickup the installation packages from the VI-
grade website support area (registration is required).

VI-CarRealTime is shipped primarily in 64 bit form:


· VI_Crt_20_1_x 64_Setup.ex e: main product 64 bit installer, including the entire VI-CarRealTime suite.
· VI_Crt_20_1_Installing.pdf: this document.
· VI_Crt_20_1_Release_Notes.pdf: product information.

In case you are interested in Adams Car export capability, you need to download the package for the desired
Adams version:
· VI_Crt_plugin_2020_20_1_x 64_Setup.ex e: VI-CarRealTime interface for Adams Car 2020.0 64 bit.
· VI_Crt_plugin_2019_20_1_x 64_Setup.ex e: VI-CarRealTime interface for Adams Car 2019.0 64 bit
· VI_Crt_plugin_2018_20_1_x 64_Setup.ex e: VI-CarRealTime interface for Adams Car 2018.0 64 bit.
·
Finally, several extensions, related to the hardware in the loop (HIL) targets, are available as separate installation
packages:

© 2020 VI-grade GmbH


VI-CarRealTime 20.1 Installation Guide 5
Installation Guide

· VI_Crt_scalex io_20_1_r18b_Setup.ex e: extension package for the dSPACE Scalexio target


· VI_Crt_ni_px i_20_1_x 86_Setup.ex e: extension package for the National Instruments PXI environment
· VI_Crt_etas_20_1_x 86_Setup.ex e: extension package for the ETAS target

1.1.2 Running the Installer


After reviewing the Release notes document, the installation could start following the steps below:

1. Double click over the VI_Crt_20_1_Setup.exe file, and follow the instructions that will appear on the screen.

Product Information
License Agreement
Installation Type

Product Information
Just click on the “Next” button to proceed.

License Agreement
Read the license agreement carefully. The check box will enable the “I Agree” button required to proceed
with the application setup.

© 2020 VI-grade GmbH


6 VI-CarRealTime 20.1 Installation Guide
Installation Guide

Installation Type
Select the type of installation you desire:

· Standard: installs VI-CarRealTime in the target location.

· Network: allows to call VI-CarRealTime installed on a remote machine sharing a standard installation.

1.1.3 Standard Installation


The standard installation is composed by the following sections:
· Components
· Installation Folder
· Installing

Components
If you have chosen the standard installation type, select the components you want to install.

Click “Next”.

© 2020 VI-grade GmbH


VI-CarRealTime 20.1 Installation Guide 7
Installation Guide

Installation Folder
If you have selected the standard installation type choose a desired installation folder where you want VI-
CarRealTime files to be copied and click “Next”.

Please, notice that the installer will install VI-CarRealTime accessories into directories at the same level of the
one you chose. As an example, if you chose to install VI-CarRealTime at C:\Program Files\VI-grade\VI-
CarRealTime 20 then the accessories will be installed at C:\Program Files\VI-grade\VI-Road 20, C:\Program
Files\VI-grade\VI-Animator 20 and so on.

Installing
If another installation of the same version of VI-CarRealTime is present, you will be prompted with the following
message:

That's because you cannot have multiple installations of VI-CarRealTime featuring the same version on the same
machine. If this message appears then, please, accept by pushing the OK button.

Once the installation has started, wait until the process is complete.

© 2020 VI-grade GmbH


8 VI-CarRealTime 20.1 Installation Guide
Installation Guide

At the end of the installation you'll be asked to enter the VI-CarRealTime license.
You can specify an IP or an alias:

6200@hostname (6200@localhost if the license is on the same machine on which you're installing)
or
6200@IPaddress

Now the files should be copied into the installation directory.

© 2020 VI-grade GmbH


VI-CarRealTime 20.1 Installation Guide 9
Installation Guide

Just select the “Finish” button to complete the installation procedure. You will find a shortcut to VI-CarRealTime
on Windows application menu under VI-grade folder.

At the end of the installation procedure, a file named: install-crt-20-1.log will be available in the installation
directory.

1.1.4 Network Installation


The network installation is composed by the following sections:
· Installation Folder
· Installing

Note: the network installation mode is designed to allow the execution on the current machine of an installation
residing a different host (on which a standard installation has been performed). For most of the cases, the
standard installation mode should satisfy your needs.

Installation Folder
If you have selected the netwok installation type, select the network path to an existing VI-CarRealTime standard
installation.

© 2020 VI-grade GmbH


10 VI-CarRealTime 20.1 Installation Guide
Installation Guide

Installing
If another installation of the same version of VI-CarRealTime is present, you will be prompted with the following
message:

That's because you cannot have multiple installations of VI-CarRealTime featuring the same version on the same
machine. If this message appears then, please, accept by pushing the OK button.

Once the installation has started, wait until the process is complete.

At the end of the installation you'll be asked to enter the VI-CarRealTime license.
You can specify an IP or an alias:

6200@hostname (6200@localhost if the license is on the same machine on which you're installing)
or
6200@IPaddress

© 2020 VI-grade GmbH


VI-CarRealTime 20.1 Installation Guide 11
Installation Guide

Now the files should be copied into the installation directory.

Just select the “Finish” button to complete the installation procedure. You will find a shortcut to VI-CarRealTime
on Windows application menu under VI-grade folder.

At the end of the installation procedure, a file named: install-crt-20-1.log will be available in the installation
directory.

1.1.5 Batch Installation


It is also possible to run the VI-CarRealTime installer in batch mode using the /S option (silent mode). Additional
available options are:

/INSTTYPE: available options are:


· standard
· network
/INSTDIR: sets the installation folder (mandatory)
/MSCLIC: for client installation, sets the path for MSC license used for ADAMS/PPT (optional)
/VIGLIC: for client installation, sets the path for VI-grade license (optional)

Ex amples:

Batch standard installation


VI_Crt_20_1_x64_Setup.exe /S /INSTTYPE=standard /INSTDIR="C:\Program Files\VI-grade\VI-
CarRealTime".

Batch netw ork installation


VI_Crt_20_1_x64_Setup.exe /S /INSTTYPE=network /INSTDIR="X:\Program Files\VI-grade\VI-
CarRealTime" /MSCLIC=27500@licserver /VIGLIC=6200@licserver.

1.1.6 Uninstalling
The uninstallation of VI-CarRealTime can be performed by using Windows Programs and Features tool or by
selecting uninstall_vicrt.ex e stored in VI-CarRealTime installation folder. You will then be prompted with the
following forms:

© 2020 VI-grade GmbH


12 VI-CarRealTime 20.1 Installation Guide
Installation Guide

This is the list of the components that are part of VI-CarRealTime and that can be used even if VI-CarRealTime is
not installed. By default, all of them will be uninstalled. The uninstall procedure will look for those components in
the directories where they were installed by the VI-CarRealTime installer. Those that cannot be found will be
skipped.

1.2 Setting up the License


Running VI-grade products always requires the installation of VI-Licensing on the local computer in case of a node
locked license or on a computer (license server) in the network in case of a network license.
We recommend to install VI-Licensing prior to installing the application although it is not absolutely required.
Please note that VI-grade licensing version 20.0 or newer is required to run this product.You should have received
detailed information regarding the installation and operation of the licensing system together with the license file.
If not please download the licensing system for your platform from the VI-grade website support area (registration
is required).

No matter what type of license you are running (node locked license or netw ork floating), during the
installation of the client application, you need to define on which machine the license server is running. Every LM-
X protected application has a search path for licenses defines as follows:

Order Search path

© 2020 VI-grade GmbH


VI-CarRealTime 20.1 Installation Guide 13
Installation Guide

1 The environment variable VIGRADE_LICENSE_PATH.

On Windows we recommend setting the environment variable using the system control panel:

Variable Name: VIGRADE_LICENSE_PATH


Value: 6200@servermachine

Notes:
· for a node-locked license it is sufficient to set VIGRADE_LICENSE_PATH value to 6200@localhost .
· VI-grade currently issues only license that uses the COUNT key and as such requires the operation of
a license server also for node-locked licenses.
· Windows and Linux OS requires different separators when declaring multiple servers on the
VIGRADE_LICENSE_PATH environment variable:
Windows: VIGRADE_LICENSE_PATH=6200@server1 ;6200@server2
Linux: VIGRADE_LICENSE_PATH=6200@server1 :6200@server2

In order to run simulation with the F-Tire module please make sure to properly configure the connection to a valid
F-Tire license server using the Cosin/Tools module available in the Utilities menu of the VI-CarRealTime interface.
Please refer to the F-Tire documentation or to the Cosin Scientific Software website (www.cosin.eu) for problems
related to F-Tire.

In order to run simulation with the MF-Swift module, please make sure to properly configure the connection to a
valid TASS license server using the environment variable MADLIC_LICENSE_FILE. Please refer to the MF-Tyre
documentation for more information on MF-Tyre installation.

1.3 Troubleshooting
The aim of this topic is to report the most common troubleshooting with licensing.

1. Problems w ith license server

If the software doesn't start up, the first thing to check is that license server has been correctly set up.
In particular it can be useful to look at lmx-serv.log file stored in VI-Licensing folder in the server machine.
Such file logs all main server activities and if something goes wrong during server initialization (read
license keys), or during check-out or check-in of a feature key, a message will be written in the log file.

Here the statements that are generally written when server initialization has been successful:

[2017-02-17 11:23:25] LM-X License Server v4.6.4 build a9ec77a9 on TPW520 (Win32_x86)
[2017-02-17 11:23:25] Copyright (C) 2002-2014 X-Formation. All rights reserved.
[2017-02-17 11:23:25] Website: http://www.lm-x.com http://www.x-formation.com
[2017-02-17 11:23:25] License server has pid 4800.
[2017-02-17 11:23:25] Serving licenses for vendor VIGRADE.
[2017-02-17 11:23:25]
[2017-02-17 11:23:25] License server using TCP IPv4 port 6200.
[2017-02-17 11:23:25] License server using TCP IPv6 port 6200.
[2017-02-17 11:23:25] License server using UDP IPv4 port 6200.
[2017-02-17 11:23:25] Reading licenses...
[2017-02-17 11:23:25] License file(s):
[2017-02-17 11:23:25] C:\Program Files (x86)\VI-grade\VI-Licensing\license.lic
[2017-02-17 11:23:28] Log file path: C:\Program Files (x86)\VI-grade\VI-Licensing\lmx-serv.log
[2017-02-17 11:23:28] Log to stdout: No
[2017-02-17 11:23:28] Log format: Normal
[2017-02-17 11:23:28] Configuration file path: C:\Program Files (x86)\VI-grade\VI-Licensing\lm
[2017-02-17 11:23:28] Serving following features:
[2017-02-17 11:23:28] VI_CarRealtime_IFace (v17.0) (100 license(s)) license type: exclusive
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

© 2020 VI-grade GmbH


14 VI-CarRealTime 20.1 Installation Guide
Installation Guide

[2017-02-17 11:23:28] VI_Driver_Basic_Core (v17.0) (100 license(s)) license type: exclusive


. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[2017-02-17 11:23:29] VI_Tire_Core (v17.0) (100 license(s)) license type: exclusive
[2017-02-17 11:23:29]
[2017-02-17 11:23:29] To administrate the license server go to page http://SERVER_PC:6200
[2017-02-17 11:23:29] Ready to serve...

The work flow is:


1. license server is initialized
2. the port used for TCP and UDP connection is logged: the port used is TCP_LISTEN_PORT
parameter defined in lmx-serv.cfg file in VI-Licensing folder
3. lic file is parsed and all feature keys are read: license file used is the one referenced in
LICENSE_FILE parameter defined in lmx-serv.cfg file
4. once all keys are read, the server is Ready to serve...

Note: sometimes the following messages might be found in the server log:

[2017-02-17 11:23:25] WARNING: Windows firewall blocks TCP port 6200.


[2017-02-17 11:23:25] WARNING: Communication to license server might not work properly.
[2017-02-17 11:23:25] WARNING: Windows firewall blocks UDP port 6200.
[2017-02-17 11:23:25] WARNING: Automatic server discovery might not work properly.

Such messages don't always mean that TCP/UDP block is actually locked by Windows firewall, anyway
it's recommended to double check that no antivirus or firewall is preventing data flow from such port: the
port is used to exchange data between client and server (also for a node-locked license where server and
client are in the same machine).

Whenever something goes wrong during server initialization, a message reporting the error will be written
in lmx-serv.log file. For details on the error please refer to x-formation site and send an e-mail to
support@vi-grade.com with lmx-serv.log file in attachment.

Same concept for check-out and check-in of a feature key; here a proper check-out/in or a key:

[2017-02-17 12:43:54] CHECKOUT by USER@TPW520 [::1]: VI_CarRealtime_IFace

[2017-02-17 17:04:46] CHECKIN by USER@TPW520 [::1]: VI_CarRealtime_IFace

If something goes wrong during check-out and/or check-in, the error will be written in lmx-serv.log.

2. Unable to locate a valid license...

If a panel with a message like " Unable to locate a valid license... " shows up when trying to launch one of
VI-grade software, it means that the client application hasn't been able to communicate with the server
(the machine where VI-Licensing is installed).
So, after checked that on server side everything has been correctly set up, what needs to be done is to
check that VIGRADE_LICENSE_PATH environment variable is set in client machine and that its value is
correctly defined. Please refer to Setting up the License topic for all the details about how to set up the
environment variable.
If the problem persists, check that no LMX_LICENSE_PATH variable exists among environment variable
pool, since LM-X looks for it as well as for VIGRADE_LICENSE_PATH one.

Another factor that might lead to such error is due to boost_interprocess folder. boost_interprocess is an
hidden folder that is created to store a binary file used to exchange information among different processes
protected by the license system. If the first time the software has been executed with administrator rights,
such binary file is created with just administrator permission so a standard user can’t read it. In general,
removing the folder and starting again the software as standard user solves the problem. Please refer to x-
formation Interprocess issue topic for all the details.

© 2020 VI-grade GmbH


VI-CarRealTime 20.1 Installation Guide 15
Installation Guide

Further hints:
· check that communication between client and server machine is ok: from a shell dos type the
command ping <server_machine_name> and check that the packages are correctly exchanged;
· check that an antivirus or a firewall system isn't blocking the communication through the port used to
exchange data ( 6200 by default).
· launch the software with Administrator rights;
· check if the server machine is using another software which relies on the same LM-X licensing and in
case make sure that they're not communicating through the same port. A possible solution for such
a problem consists in changing the port used by one of the two applications.

If the problem is still open, set LMX_EXTENDEDLOG environment variable in client machine (refer to x-
formation Enabling extended logging topic for the details) and send an e-mail to support@vi-grade.com
with the log file generated in attachment.

1.4 License Toolkit


License toolkit executable (license_toolkit.ex e) is shipped in license folder of VI-CarRealTime installation
directory.

To use it, just open a command prompt ( cmd.exe ) and call the executable with the options described below.

Available command options:

-check feature_name
check for a specific feature availability.

-expiration feature_name
check for remaining time before the selected feature expires.
Note: if the time left is less than 1 hour, it will answer that the feature is already expired, but the user will
be able to use that feature for all the minutes left.

-borrow feature_name time


borrow a specific feature for the selected time (time in hours). The license is now deployed on the local
machine for the given amount of time (and removed from the server for the same amount of time).
The license is returned automatically to the server after the borrow ing time (while the local machine
loose the license).
Note: if trying to borrow a feature already borrowed, you'll get an error about an invalid input parameter.
Note: If your allowed borrowing time (see licensing specs) is less than required (eg. 10h max instead of
24) or you have not the borrowing enabled the answer will be:

>>VI-grade licensing ERROR: feature borrowing failed


>>ERROR = The specified borrow period is too long
>>VI_Bike_Core license borrowing failed

-return feature_name
to return a specific feature previously borrowed, before the borrowing expiration time.

-borrowproduct productname time


borrow the set of features required by product prodname for the selected time (time in hours). The license
is now deployed on the local machine for the given amount of time (and removed from the server for the
same amount of time).

© 2020 VI-grade GmbH


16 VI-CarRealTime 20.1 Installation Guide
Installation Guide

If the borrowing request has succeeded, the features borrowed will be listed as successful.
The license is returned automatically to the server after the borrow ing time (while the local machine
loose the license).
Note: If the product name provided is wrong, a list of all available product names will be shown.
Note: if trying to borrow a product already borrowed, you'll get an error about an invalid input parameter.
Note: If your allowed borrowing time (see licensing specs) is less than required (eg. 10h max instead of
24) or you have not the borrowing enabled the answer will be:

>>VI-grade licensing ERROR: feature borrowing failed


>>ERROR = The specified borrow period is too long
>>VI_Bike_Core license borrowing failed

-returnproduct productname
return the set of features related to product name, before the borrowing expiration time.
Note: If the product name provided is wrong, a list of all available product names will be shown.

-featuresfile file_name
definition file listing features for each product.

Note: the application is case sensitive, so be sure to type correctly the product or the feature name.

© 2020 VI-grade GmbH


www.vi-grade.com
email: info@vi-grade.com

© 2020 VI-grade GmbH

You might also like