Esysx Tutorial 1 4

You might also like

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

EsysX Manual

EsysX Team
July 28, 2021

1
Contents
1 Introduction 5

2 What is EsysX 5
2.1 EsysX license types . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 EsysX types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 Compatibility with Esys and Windows . . . . . . . . . . . . . . . 5

3 Installing EsysX 7
3.1 Installing EsysX the first time . . . . . . . . . . . . . . . . . . . . 7
3.2 Updating an existing EsysX version . . . . . . . . . . . . . . . . 8
3.3 Upgrading an existing EsysX version . . . . . . . . . . . . . . . . 9
3.4 Possible errors while installing/updating EsysX . . . . . . . . . . 9

4 Configuration of EsysX/IspiHost Admin 10


4.1 IspiHost Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.1.1 EsysX Options . . . . . . . . . . . . . . . . . . . . . . . . 10
4.1.2 Ediabas Options . . . . . . . . . . . . . . . . . . . . . . . 12
4.1.3 Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.2 IspiHost Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.3 EsysX 32/64 bit . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.4 Remote ENET Helper . . . . . . . . . . . . . . . . . . . . . . . . 14

5 Features 16
5.1 IspiHost Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.1.1 Navi FSC Generator . . . . . . . . . . . . . . . . . . . . . 18
5.1.2 8HP ISN Reset . . . . . . . . . . . . . . . . . . . . . . . . 20
5.1.3 FSC Explorer/FSC Store . . . . . . . . . . . . . . . . . . 23
5.1.4 Diag Devices . . . . . . . . . . . . . . . . . . . . . . . . . 24
5.2 EsysX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.2.1 Remapping of all function/parameter names & Remap-
ping of FAFP elements . . . . . . . . . . . . . . . . . . . . 26
5.2.2 Visual FA/VO editor for HO/E/SALAPA elements . . . . 26
5.2.3 Show conditional parameters in CAF/FDL viewer . . . . 28
5.2.4 Compare NCDs . . . . . . . . . . . . . . . . . . . . . . . . 29
5.2.5 FDL cheatsheets . . . . . . . . . . . . . . . . . . . . . . . 31
5.2.6 FDL scripting . . . . . . . . . . . . . . . . . . . . . . . . . 34
5.3 EsysX Expert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
5.3.1 Series information in connection dialog . . . . . . . . . . . 35
5.3.2 Evaluation of conditions in CAF/FDL Viewer . . . . . . . 36
5.3.3 Construction preview SVT calculation . . . . . . . . . . . 38
5.3.4 NCD/FDL calculation with FA + SVT . . . . . . . . . . 39
5.3.5 KIS Features . . . . . . . . . . . . . . . . . . . . . . . . . 43
5.3.6 One-Click-Backup . . . . . . . . . . . . . . . . . . . . . . 45
5.3.7 Reboot ECU . . . . . . . . . . . . . . . . . . . . . . . . . 50

2
5.3.8 Read additional infos from ECU . . . . . . . . . . . . . . 51
5.4 EsysX 8HP ISN Reset . . . . . . . . . . . . . . . . . . . . . . . . 53
5.5 Remote ENET helper . . . . . . . . . . . . . . . . . . . . . . . . 53

6 Update/Upgrade your EsysX License 54


6.1 Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6.2 Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6.3 FSCs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

7 FAQs 56

3
Revision History

Revision Date Author(s) Description


1.0 23.11.2020 EsysX Team Initial
1.1 24.11.2020 EsysX Team Added license comparison table
1.2 21.03.2021 EsysX Team Added second picture for the result of
evaluated boolean expressions
1.3 04.04.2021 EsysX Team Added EsysX icon to title page;
Added new Expert features: "One-
Click-Backup", "KIS", "Reboot ECU",
"Read additional infos from ECU";
Added adjusted comparison table pic-
ture including new expert features and
Esys 3.37.1/2 compatibility
1.4 28.07.2021 EsysX Team Added centralized download page
for RemoteENET; Added fallback
method for EGS Reset if a remote con-
nection to clients PC cannot be estab-
lished in IspiHost Admin

4
1 Introduction
This document provides all necessary information on how to configure and run
EsysX/IspiHost Admin as well as feature descriptions for them. Make sure to
always have the latest version of this file which can be found on www.esysx.
com/manual. To check the current documents version, see the revision history
on page 4.

2 What is EsysX
EsysX is a Launcher for Esys to enable FDL Coding and to add the untrimmed
parameter names and descriptions back to the CAFD files. EsysX is NOT Esys
nor does it contain Esys. It just launches an installed Esys version and modifies
its code during runtime to enable more advanced features.

2.1 EsysX license types


There are two types of licenses you can choose from:
EsysX Standard A software license which is bound to a single PC’s hardware.
It does not work in virtualized environments (VMs)
EsysX Dongle A hardware (dongle) license which can be used on multiple
PCs. It also works on VMs

2.2 EsysX types


EsysX can be purchased in different versions. You can compare any difference
on http://www.esysx.com/licenses

EsysX EsysX is the license for most people who only want to do coding on their
car. It contains all untrimmed parameters. For an overview of features,
see section 5.
EsysX Expert EsysX Expert adds more advanced functions to EsysX like
calculating codings outside of a car. For an overview of features, see
subsection 5.3.
EsysX ISN Reset EsysX ISN Reset provides a feature to reset 8HP EGS. To
learn how it works, see subsubsection 5.1.2

2.3 Compatibility with Esys and Windows


When buying EsysX in 2020, you will get 32 and 64-bit Esys compatibility
out of the box. If you have purchased it at times, where only Esys 32 bit was
supported, then you need an upgrade of your license to use 64-bit Esys Versions.
You can use 64-bit EsysX if you have a 64-bit Esys version installed and if your

5
OS (Windows) is a 64-bit version.
EsysX 32-bit and 64-bit should be fully compatible with any windows version.
Windows 10 2004 modified system DLLs in a way that cause EsysX to crash.
If that happens to you and you are on Windows 10 2004 then you might need
an update of your license. Refer to section 6 for updating your license.

6
3 Installing EsysX
This section describes how to install or update/upgrade your EsysX (Stan-
dard/Dongle) on your laptop.
You should have received your EsysX License by mail. It contains a link to your
EsysX license as well as the password for the archive. Download it and unpack
the installer via e.g. 7zip.

3.1 Installing EsysX the first time


If you are installing EsysX for the first time, just launch the installer and it will
do everything for you.
Also, make sure to add us exception to the following folders, else your license
might not work correctly:

• C:/Program/Files (x86)/IspiHost
• C:/ProgramData/IspiHost
As soon as the installer is done, you should see the IspiHost Admin service
starting. You can open it by clicking its icon in the toolbar.
Go to Settings -> Support and click the "Activate License" button to activate
your license (see Figure 1). If it is already activated, then the button says
"Reactivate License". In this case, you don’t have to do it again. Your EsysX
is now ready to be configured. Continue with section 4 to do so.

7
Figure 1: Activate your license via the "Activate License" button. If it is already
activated, it will say "Reactivate License"

3.2 Updating an existing EsysX version


If you are updating your EsysX license, then you must first uninstall your current
EsysX installation from control panel. To do so, open up the Windows control
panel, search for "EsysX" and click uninstall. The uninstaller will be started
and will do everything for you. As soon as it closes, your current EsysX version
is removed.
Continue by double clicking your new EsysX installer. It will take you through
the steps of installation. As soon as it is done, your IspiHost Admin icon will
pop up in the toolbar and your license should already be activated again. If
not, press the "Activate License" button in IspiHost Admin (see Figure 1).
If your IspiHost service does not start after installing your update/upgrade,
refer to subsection 3.4.

8
3.3 Upgrading an existing EsysX version
If you have bought an upgrade, installation process is exactly the same as in-
stalling an update. Refer to subsection 3.2 to install your upgrade.

3.4 Possible errors while installing/updating EsysX


• Antivirus finds a "virus" during uninstalling EsysX: If you haven’t added
antivirus exceptions for EsysX folders like described in subsection 3.1,
your antivirus program might put a temp file into quarantine while unin-
stalling. If this is the case, you have to add the exception to your antivirus
program first, then restart your pc before continuing with installation)

• IspiHost service fails to start: In some cases, after updating/upgrading


your license, the IspiHost service might fail to start. If this happens,
remove the current EsysX version again from control panel, then restart
your PC and install it again. This happens, if the service fails to be
stopped during uninstallation.

• An error pops up during installation, that EsysX cannot be installed in


the current environment. Contact support if this is the case.

9
4 Configuration of EsysX/IspiHost Admin
This section describes how to configure EsysX and IspiHost Admin, as well as
the IspiHost Service. This section does not contain information on how to use
IspiHost Tools or EsysX itself. All features are described in section 5.

EsysX contains of the following components:


IspiHost Admin IspiHost Admin is used for configuring EsysX. It checks for
your license priviliges and provides further tools which are described in
subsection 5.1.
IspiHost Service Windows Service which acts as a bridge between IspiHost
Admin and the EsysX Servers (e.g. for license activation)
EsysX 32bit launcher The launcher which you have to use to launch a 32 bit
Esys installations. If you have configured a 32 bit installation in IspiHost
Admin, you must use this launcher (icon) to start up EsysX. You will find
it on your desktop after installation.
EsysX 64bit launcher The launcher which you have to use to launch a 64 bit
Esys installation. If you have configured a 64 bit installation in IspiHost
Admin, you must use this launcher (icon) to start up EsysX. You will find
it on your desktop after installation.
Remote ENET Helper little helper tool which lets you connect your EsysX
to a car connected to a clients computer over VPN.

The configuration of each component is described in its own section below.

4.1 IspiHost Admin


If you open up IspiHost Admin from the toolbar and go to "settings", then you
have three configuration menus:

EsysX Options Configuration of EsysX. See subsubsection 4.1.1 for in-depth


configuration.
Ediabas Options Configuration of Ediabas. Needed for ISN reset and FSC
generator’s direct connection functions. See subsubsection 4.1.2 for in
depth configuration.

Support Configuration of IspiHost Admin Windows service and lookup.xml.


See subsubsection 4.1.3 for in depth configuration.

4.1.1 EsysX Options


All further configuration is described based on Figure 2

10
Before you can open up EsysX the first time, you have to choose your Esys
installation which is either 32 bit or 64 bit. Of course, you can have multiple
Esys installations on your computer but you have to choose one of them for
EsysX to launch. You can have a 32 bit and 64 bit Esys installation configured
simultaneously. All options below the 32/64 bit radio buttons are done for the
selected 32/64 bit version.
(If you do not have the 64 bit option yet, you may have purchased EsysX before
64 bit was included in any license for free. If this is the case and you want to
run a 64 bit Esys version then you have to buy a 64 bit Upgrade over our shop.)
After choosing 32/64 bit, click the little folder icon and navigate to your Esys
root folder in the opening popup, then click "choose folder" to select it.

Est Token can always remain on "Use Default", there is no need to create
a custom Est in order to fully use EsysX. If you want though, you can create
one with the "Create custom Est" and then selecting it in the Est Token menu.

You either have to choose between FDL cheat codes or FDL scripts
which will be shown in the Esys’ FDL editor.
Enabling "FDL cheat codes" also enables you to "Merge Cheat Code Files" which
lets you choose 1-n cheat code files and merge them into a single file so you can
use all of them in EsysX.
Enabling FDL scripts has no further option.

At the bottom right corner, you can enable a Diff Tool of your choice which
provides a commandline runner and configure its commandline arguments. To
do so, install e.g. Winmerge on your computer, then hit the "NcdDiff Tool"
button to configure the commandline arguments "<left> <right>" in there.
Hit Apply to finish configuration of your diff tool. It is now ready to be used
for EsysX. The diff tool is configured globally for 32/64 bit.

11
Figure 2: EsysX Options

4.1.2 Ediabas Options


All further configuration is described based on Figure 3

All vehicle based operations (FSC Explorer if reading out FSCs from vehicle;
Toolset (currently only EGS ISN reset)) in IspiHost Admin use Ediabas. If you
use one of those functions, make sure to have a native Ediabas configuration
and choose it via clicking the folder icon for "Bin Folder" as well as the "Ecu
folder". Do further configuration below those options to your needs.

12
Figure 3: EsysX Options

4.1.3 Support
All further configuration is described based on Figure 4

The support page shows the current activation state of your installed
EsysX license. If your license is not automatically re-activated after an up-
date/upgrade, then you can click "Reactivace License" to do so.
USB Key shows the state of your dongle, if you are using a hardware (dongle)
EsysX license.
To prevent having the IspiHost Service always running in background, you
can use "On Demand" radio button to only have the service running if you want
it to. Default is "Automatic", which means that the service starts with windows.
Navi Map Definitions, also known as Lookup.xml, are shipped with your
EsysX license but not updated after that. If you have a new "Lookup.xml", you
can load it via clicking the folder icon next to "Navi Map Definitions".
Language setting is currently not used.

13
Figure 4: EsysX Options

4.2 IspiHost Service


IspiHost Service cannot be configured itself. All configuration is done within
IspiHost Admin -> Settings -> Support, which currently is only the startup
behaviour. Refer to subsubsection 4.1.3.

4.3 EsysX 32/64 bit


All EsysX (Expert, ISN Reset) related settings are configured in IspiHost Ad-
min. Refer to subsubsection 4.1.1. Use one of the launch icons on your desktop,
to start EsysX 32/64 bit.

4.4 Remote ENET Helper


Remote ENET tool does not need to be configured. You can find it on your
computer at C:/Program Files (x86)/IspiHost.. While we are going to remove

14
it from the installation folder, the one and only download source is https:
//esysx.com/remote_enet/.

15
5 Features
This section describes how to use any EsysX feature. This includes features in
IspiHost Admin as well as EsysX itself. The availability of all features depend
on your IspiHost Admin version as well as your bought license. The prerequi-
sites are described at the beginning of every features’ section.
To have a quick overview of which feature each EsysX license type supports, go
to www.esys.com/licenses and check the table at the beginning of the page.
While the same table is also added below (see Figure 5), our page is always up
to date.
If a feature for IspiHost Admin or EsysX is not present in your verion, you either
need an update or an upgrade depending on the wanted/missing feature. Refer
to section 6.

Features in this section are described by "Preconditions" which are conditions


that have to be met in order to use that feature. Any feature in EsysX/IspiHost
Admin require an activated license as well as the running IspiHost service as
precondition (and of course, the feature must have been bought).
"Usage" describes the actual use of that function if all preconditions are met.

16
17

Figure 5: Each license has its own set of features


5.1 IspiHost Admin
IspiHost Admin provides multiple advanced tools (this list is based on IspiHost
Admin version 2.3.0.1). A quick overview:
Navi FSC Generator Found under Tools -> Applets -> Navi Fsc Generator.
Generates FSC codes for Champ2, CIC, EntryNav, NBT, NBTEvo ID4.
See subsubsection 5.1.1.
Toolset Found under Tools -> Applets -> Toolset. Set of advanced tools.
Currently only contains 8HP ISN Reset. See subsubsection 5.1.2.
FSC Explorer Found under Tools -> FSC Explorer. It lets you browse and
export generated FSC codes by Navi FSC Generator as well as imported
FSCs from car. See subsubsection 5.1.3.
ICOM Tools Found under Devices -> Diag Devices. Shows found ICOMS,
lets you reserve, configure and update them. See subsubsection 5.1.4.

5.1.1 Navi FSC Generator


Preconditions:

• Enough credits for the map you want to generate an FSC for (number in
top right corner in Figure 6). If you don’t have enough credits, refer to
subsection 6.3.
• Either connected to a car or having a local .fsc file on your PC for the
desired car

• If you want to read out an FSC from a connected car, Ediabas must be
installed and configured
Usage
1. If you have a local .fsc file on your PC, click the Import button and select
it. The FSC will be selected and also imported in your FscStore.
If you are connected to a car and want to read out the .fsc file, click
Import, then "Read Vehicle" in the bottom right corner (See Figure 7).
2. Select your options like "Lifetime", the map version
3. Click "Generate", your new FSC will be displayed and also saved to your
FscStore.

18
Figure 6: Navi FSC Generator

19
Figure 7: Read FSC from car

5.1.2 8HP ISN Reset


This section describes how to reset your 8HP EGS ISN with EsysX. Those
are very short explanations. You can also find a full video tutorial on https:
//www.youtube.com/watch?v=TPUCplYzBi0.

Preconditions:

• EsysX 64 configured (not supported in 32 bit)


• Ediabas configured
• Connected to a car (or EGS in general)

• SWFL of EGS must be supported for ISN reset. Check www.esysx.com/


licenses for a recent compatibility list.
Usage
1. Go to IspiHost Admin’s Toolset Window (Figure 8) and select Egs Unlock
from the Tool dropdown if not selected yet.

2. If you don’t have full psdzdata, click "Download File Support" which will
download all BTLD, SFWL and CAFD for supported EGS variants.
3. Click "Detect" and identify the EGS

20
4. Click "Create Tal" to generate the flash TAL for the reset
5. Launch EsysX, connect to the car and go to the TAL execution window
6. Check the "Unlock EGS" checkbox as seen in Figure 9
7. Check for software availability. If there are missing files, hit the "..." button
to import missing files into your psdzdata directory
8. Check for software again if you imported them previously
9. Proceed with the EGS flash

10. Switch back to IspiHost Admin and detect your EGS. Check the ISN state.
If reset successfully, restart the EGS by clicking "Restart EGS" in IspiHost
Admin.
11. Switch to EsysX and calculate a TAL for EGS flash as you would do when
updating the car.

12. Flash the EGS again with an original TAL


13. Check EGS ISN state in IspiHost Admin and it should be locked again to
the new car
If you cannot remotely connect IspiHost Admin to the clients car but Esys(X)
connects, the following alternative Usage works:
1. Launch EsysX, connect to the car and go to the TAL preparation window
2. Create an update TAL by calculation SVT_CURRENT and SVT_TARGET
then calculating the TAL. BTLD and SWFLS must be flashed to unlock
EGS. If a BTLD or SWFL is not intented to be updated by EsysX, edit
the SGBMID in the SVT_CURRENT to 0, then recalculate TAL
3. Check the "Unlock EGS" checkbox as seen in Figure 9
4. Check for software availability. As you are using an update TAL, every-
thing should be present.

5. Proceed with the EGS flash -> EGS should be unlocked afterwards
6. Flash the EGS again with the same TAL but "Unlock EGS" unchecked ->
EGS should be locked again

21
Figure 8: 8HP ISN Reset

22
Figure 9: EsysX 8HP ISN Reset TAL execution

5.1.3 FSC Explorer/FSC Store


The FSC Explorer or FSC Store stores all your imported FSCs from any car
plus generated FSCs in one place for better overview:

Preconditions:

• None
Usage
• To import local stored FSCs, head over to the Navi FSC Generator (see
Figure 6) and click "Import", then select your .fsc file for example. Make
sure to set the file type accordingly in the file chooser dialog (.fsc, .xml,
.zip).
• To import an FSC from a connected car, right click the FSC store’s main
folder icon (Figure 10) on the left "Vins" panel and choose "Import from
car".

• You can also export any displayed folder by clicking its icon and selecting
"Export as zip".

23
Figure 10: FSC Explorer

5.1.4 Diag Devices


The Diag Devices tool is an ICOM manager like iToolRadar.

Preconditions:
• Connected ICOM
Usage

• Any function of that tool is self explaining from the button names. There
isn’t any other hidden features (Figure 11).

24
Figure 11: Diag Devices (ICOM tools)

5.2 EsysX
This section describes all features which are present in EsysX standard license.
To compare them to the other license types, please have a look at https:
//esysx.com/licenses/:
• Remapping of all function/parameter names in all CAFDs
• Remapping of HO/E/SALAPA elements in FAFPs
• Visual FA/VO editor for HO/E/SALAPA elements
• Show conditional parameters in CAF/FDL viewer
• Compare NCDs
• FDL cheatsheets
• FDL scripting

25
5.2.1 Remapping of all function/parameter names & Remapping of
FAFP elements
Preconditions:
• Psdz data on your PC

Usage
• There is nothing to do for you. Any remapping/untrimming is done in
memory.

5.2.2 Visual FA/VO editor for HO/E/SALAPA elements


Preconditions:
• Psdz data on your PC

• Be in FA-Editor and have an FA/VO loaded


Usage
• To open the visual editor for SALAPA elements, select the "SALAPA-
Element" node in the FAList tree, then click the little book icon next to
the SALAPA-Element header (see Figure 12)
• Top open the visual editor for HO or E words, select the HO-Wort or
E-Wort node in the FAList tree, then right click it and click "edit" (see
Figure 13)

• In the visual editor, you see your current elements of your FA in the left
panel and the available options on the right. Use the DEL key to remove
an option from FA or double click on an available option to add it to your
FA. You can also search for any option by code or name by using the
"Search for" text box at the bottom

26
Figure 12: To open up the editor for SALAPA elements, select the SALAPA-
Element node in the tree, then click the little book icon

27
Figure 13: To open the editor for E and HO words, click on the E-Wort/HO-
Wort node in the tree, then right click and select "edit"

5.2.3 Show conditional parameters in CAF/FDL viewer


Preconditions:
• Be in FDL/CAF Editor

• Have an NCD loaded


Usage
• Activate the "Activating Conditions" checkbox above the FDL to load all
conditional expressions into the FDL tree (see Figure 14)

28
Figure 14: You can enable conditional expressions by checking the "Activating
Conditions" checkbox

5.2.4 Compare NCDs


Preconditions:
• NcdDiffTool configured in IspiHost Admin (see subsubsection 4.1.1)

• Be in FDL/CAF Editor
• Have an NCD loaded
Usage
• Click the icon in the EsysX toolbar next to the question mark (with the
tool file icons)
• Select the NCD which you want to compare your current loaded one
against and click "Open" (see Figure 15)
• Winmerge will automatically be opened with both files (see Figure 16)

29
Figure 15: To compare your current loaded NCD to another one, click the icon
with the two sheets next to the question mark

30
Figure 16: After selecting a second NCD, Winmerge is opened and you can see
all differences between both NCDs

5.2.5 FDL cheatsheets


Preconditions:
• FDL Cheatsheets activated and a cheatsheet selected in IspiHost Admin
(see subsubsection 4.1.1)
• Your Cheatsheet must contain valid options for the current loaded NCD
• Be in FDL/CAF Editor
• Have an NCD loaded

Usage
• After your NCD is loaded, click the "Refresh" button to load all codes for
your current NCD (see Figure 17)
• Check all FDLs which shall be automatically coded

• You can preview your codings by clicking the "Preview" button (see Fig-
ure 18)
• Click the "Apply" button to apply all selected codings. The log windows
will show all results of the automatically applied codings (see Figure 19)

31
Figure 17: You can use your cheatsheets to apply different codings

32
Figure 18: You can check the preview of changes which would be done by the
current loaded cheatsheet

33
Figure 19: After applying, check the log output if everything worked

5.2.6 FDL scripting


Preconditions:
• FDL Scripts activated in IspiHost Admin (see subsubsection 4.1.1)

• Be in FDL/CAF Editor
• Have an NCD loaded
Usage
• After your NCD is loaded, load an existing script (.scr file) or just start
typing one in the script panel (see Figure 20)
• Click the "Run" button to apply all codings within the script
• the log output will show you the result of applied codings

34
Figure 20: You can use FDL scripts to apply different codings to your current
loaded NCD

5.3 EsysX Expert


This section describes all features which are present in EsysX Expert license.
Expert license is an extension of the standard license. All features which are
present in EsysX standard license as well, are not described in this section.
Those are described in subsection 5.2.

• Series information in connection dialog


• Evaluation of conditions in CAF/FDL Viewer
• Construction preview SVT calculation

• NCD/FDL calculation with FA + SVT (“SVT-CAFD” / “FA-CAFD” In-


tegration from NCDCAFD Tool) featuring 2 calculation modes and quick
compare (2 FA/VOs)

5.3.1 Series information in connection dialog


Preconditions:
• None
Usage

35
• Series information will automatically be shown as soon as you open it up
(see Figure 21)

Figure 21: You can see all used series for each vehicle project in the connection
dialog

5.3.2 Evaluation of conditions in CAF/FDL Viewer


Preconditions:
• Bought 64 bit EsysX and using a 64 bit Esys version
• Be in FDL/CAF Editor

• Have an FDL loaded


• Checkbox "Activating Conditions" checked
Usage

• Click "Evaluate all conditions" button. Your FDL/CAFD will be reloaded


after the evaluation
• You can now see all conditions with their evaluated xpath expressions (see
Figure 22 and Figure 23)

36
Figure 22: All conditions will be validated to show the real condition containing
HO/E words, SALAPA elements, time criteria and type codes

Figure 23: All conditions will be validated to show the real condition containing
HO/E words, SALAPA elements, time criteria and type codes

37
5.3.3 Construction preview SVT calculation
Preconditions:
• Be in TAL calculation or Coding window
• Have an active connection to a car or a fake connection by trying to con-
nect to the non existing gateway, then ignore all warnings and a connection
will be established without a real car
• Have an FA/VO loaded
Usage

• Choose "Construction Preview" from the right KIS options panel (see Fig-
ure 24)
• Choose the I-Step Shipment for which you want to calculate the SVT for
• Click the "Calculate" button

• The construction preview SVT will be shown in the SVT panel. It should
be almost, if not exactly, the same as the one which is on the selected car
(through the FA) from production plant for that I-Step.

Figure 24: The construction preview SVT can be calculated by selection the
option and a shipment I-Step

38
5.3.4 NCD/FDL calculation with FA + SVT
Preconditions:
• Have the "SVT to CAFD Calculation" window opened under EsysX menu
• If you want to use any compare feature, NcdDiffTool must be configured
in IspiHost Admin (see subsubsection 4.1.1)
Usage of "Conditional evaluation" (see Figure 25)
• Load an FA/VO and SVT for the car you want to generate parameters
for

• Select ECUs of your choice for which the parameters should be calculated
for
• Select "Conditional parameters" from the options. Conditional parameters
are all parameters which are set by an explicit condition (xpath expres-
sion).

• Select "Implicit parameters" if needed. Implicit parameters are all pa-


rameters which are set by the model (set by FA/VO) regardless of any
condition. They are always true or false for the selected model.
• Click "Calculate"

• The result will be shown in the result panel. The result type is .txt.
• You can save the result in a single txt file or txt file per CAFD by clicking
the "Save" button and selecting the appropriate option

39
Figure 25: By using the "conditional parameters" option, only parameters, which
explicitly get set through FA elements, will be evaluated and shown in the result
panel in .txt format

Usage of "Full Evaluation" (see Figure 26)


• Load an FA/VO and SVT for the car you want to generate parameters
for
• Select ECUs of your choice for which the parameters should be calculated
for
• Select "All parameters" from the options. This will evaluate the complete
NCD/FDL.
• Click "Calculate"

• The result will be shown in the result panel. The result type is .fwl.
• You can save the result in a single txt file, txt file per CAFD or fwl file per
CAFD by clicking the "Save" button and selecting the appropriate option
• You can also compare each fwl to another NCD or FWL of your choice.
Click the "Compare" button and select the CAFD you want to compare,
then select another NCD or FWL from the same ECU. If you choose
an NCD, it will get converted to FWL automatically. Winmerge will be
opened up with both selected FWLs.

40
Figure 26: By using the "all parameters" option, all parameters, which get set
through FA coding, will be evaluated and shown in the result panel in .fwl
format

Usage of "2 step calculation and comparison" (see Figure 27)


• Load an FA/VO and SVT for the car you want to generate parameters
for
• Load a second FA/VO for the same car with the retrofit/change of your
choice
• Select ECUs of your choice for which the parameters should be calculated
for
• Click "Calculate and compare". Chosen options in the right bottom corner
will be ignored. Calculation will always be done with "All parameters"
mode.
• A 2 step calculation will be done. The result of the first calculation will
be shown in the result panel. The result of the second calculation will be
kept in memory.
• Winmerge will be opened with both results (see Figure 28)
• You can save the result of the first calculation in a single txt file, txt file
per CAFD or fwl file per CAFD by clicking the "Save" button and selecting
the appropriate option

41
• You can also compare each fwl to another NCD or FWL of your choice.
Click the "Compare" button and select the CAFD you want to compare,
then select another NCD or FWL from the same ECU. If you choose
an NCD, it will get converted to FWL automatically. Winmerge will be
opened up with both selected FWLs. )

Figure 27: You can do a 2 step calculation with comparison automatically by


loading a second FA with any change and hitting "Calculate and compare".
Winmerge will be opened with the comparison of both evaluations afterwards.

42
Figure 28: All differences will be shown in Winmerge after both calculations

5.3.5 KIS Features


So as some may know, the KIS databases in each psdz release hold lots of in-
formation which actually arent used or even displayed in Esys.
We took a few months and looked over each database table which information
could be useful for you to get back into Esys and to display while you are work-
ing on a car.
We implemented a whole loading and caching system around all information
which are stored. While we are currently utilizing only a part of the informa-
tion, we already built a solid codebase to implement even more in the future.
First information we implemented is probably the most anticipated information
we always would have needed when we had an SVT loaded: A description of any
SVT node, so BTLD, SWFL, CAFD, etc. to better identify multiple CAFDs of
the same ECU for example.
We currently only support the german descriptions, as english ones are not in
the databases.

Settings (see Figure 29):


• Activate KIS Features: Completely activate or deactivate loading addi-
tional information from KIS databases if you dont need them

• Which series (BRVs): Decide, which series should be loaded. If you won’t
ever have K Series (motorcycles) at your workshop, do not select it to
improve loading times. After selecting all needed series, hit "Save" and

43
restart EsysX and your information is automatically being loaded at EsysX
startup.
• Caches - invalidate: If you ever have problems with your loaded informa-
tion, invalidate the caches and they are freshly being recreated at next
EsysX startup.

Figure 29: Configure kis features and load only information from series you
need.

How does it work:


• At EsysX startup, EsysX determines if KIS features are activated and
which series to load
• Every KIS DB which is selected in settings is being queried for all needed
information.
• As soon as all information is fully loaded, it is saved locally into IspiHost’s
data folder per psdz. This means: Whenever EsysX has fully cached one
specific psdz release and you switch to a new release, then back to the old
one, EsysX uses the already cached files to reduce loading times. If you
change the series to load, EsysX will determine which caches already exist
and which need to be loaded additionally for the new series selection.
• As soon as KIS features are ready to be used, the loading bar at the bottom
will say "KIS ready". If it is not ready yet, you can still use EsysX with
all its functions, the loading is done asynchronously. But the information
for SVT is not yet usable.
• In addition, we added a functional bridge between IspiHost Admin and
EsysX. This means, EsysX uses the lookup.xml defined in IspiHost Ad-
min to request the NAVD and ENTD SVT nodes description. If EsysX

44
does not display that information, update your lookup.xml as described
in subsubsection 4.1.3
SVT node information
Preconditions:
• KIS features configured in EsysX settings menu (see Figure 29)
• Have a valid psdz loaded. Must be 17-11 and newer. Else loading KIS
information may fail.
• KIS information is done loading and loading bar at the bottom says "KIS
ready!"
Usage
• Load an SVT in any SVT module, e.g. coding module or SVT-Editor etc.
• A description of each component (see 2. in Figure 30) is added to its node.
For ECU nodes, the BNTN name (see 1. in Figure 30) is added as well.
• For Headunits, the ENTD and NAVD information is added from the in-
formation found in lookup.xml (defined in IspiHost Admin)

Figure 30: The description of the SVT nodes is added. For headunits, EsysX
requests NAVD and ENTD information from lookup.xml to add information
which Map and Gracenote version is installed

5.3.6 One-Click-Backup
While working at any BMW we always thought, making a full backup is con-
suming so much time. Creating folder structure for the connected car, read FA

45
and save it, read SVT-CURRENT and save it, read SVT from VCM and save it,
click on any CAF node in SVT then read coding data and store that file in the
cars folder... So many manual steps involved which we thought we could make
much easier by automating them, so you only have to wait while your backup
is being created.
That’s why we created the "One-Click-Backup" feature.
To configure it, go to the EsysX settings module (see Figure 31) and then its
ready to be used.
Dislaimer: Data protection law may forbid to save the VIN in any file. We do
not remove the VIN from any car related file. By using this function, you have
the responsibility to remove such data.

Figure 31: You can adjust the main folder where all backup files will be stored
and disable the clamp 15 confirmation dialog (if you are sure you won’t ever
forget to activate it)

Preconditions:
• Backup feature configured in EsysX settings menu (see Figure 31)
• Have an active connection to a vehicle
• Have clamp 15 activated in the vehicle (else it will fail to read all infos or
SVT_CURRENT may be incomplete due to some ECUs being offline)
Usage
• Click the "Backup" button next to the connection button (see 1. in Fig-
ure 32)

46
• A confirmation dialog will be shown if clamp 15 or diagnostic mode for G
models is active and if you want to proceed with creating the backup (see
2. in Figure 32)
• Clicking "Yes" will start the creation process (obviously "No" will cancel
it)
• The progress of the backup is shown live while it’s being created (see
Figure 33 and Figure 34)
• When backup creation process is done, you will see which files have been
successfully requested and saved

Figure 32: If you clicked the Backup button next to the connect button, you
will be asked if clamp 15 is activated in a modal confirmation dialog.

Figure 33: All data from VCM_Backup and VCM_Master is being requested
and saved.

47
Figure 34: Each NCD from each ECU is being requested and saved.

What is being backed up:


• Vehicle Order (FA/VO) from VCM Master and VCM Backup
• Vehicle Profile (VP) is being generated from VCM Backup Vehicle Order
and saved
• VIN from VCM Master and VCM Backup
• I-Step Current, I-Step last and I-Step Shipment
• Each NCD from each ECU contained in SVT_CURRENT is requested
and saved

48
How is the backup organized/saved:
Let’s assume, the path to the main backup folder which you configure in EsysX
settings is the "backup_main_path", then your files will be stored in the fol-
lowing location and order:

backup_main_path (e.g. D:/data/backup)

short_vin_1 (e.g. BH12345)

time_of_backup (e.g. 2021_01_01T09_11_20_090)

NCD

ecu_name_1 (e.g. ACSM)

caf_1.ncd (e.g. 00000907_0000090a.caf.004_003_078.ncd)


...
caf_n.ncd
ecu_name_n

caf_1.ncd
...
caf_n.ncd

VCM Backup

FA.xml/VO.xml

FP.xml/VP.xml

meta.txt
SVT_CURRENT.xml

SVT_TARGET.xml

VCM Master

FA.xml/VO.xml

meta.txt
SVT_ECU

short_vin_n
...

49
The meta.txt file currently includes the long VIN and I-Steps from VCM in
the following structure

Figure 35: The meta.txt file contains the VIN and I-Steps.

5.3.7 Reboot ECU


Sometimes when installing an aftermarket FSC set, an additional reboot of the
headunit is needed. As connecting via Ista, doing a car test then hard resetting
the ECU is too time consuming and doing it via Tool32 requires an additional
tool to be installed, we thought, we would add it to EsysX Expert to any eligable
SVT node (ECU node).
Preconditions:
• Have an SVT_CURRENT or SVT_ECU loaded
• Have an active connection to a vehicle

Usage
• Right click an ECU node from the SVT and choose "Reboot ECU" (see
Figure 36). The ECU is going to reboot and you will get a progress
dialog + execution result as soon as the ECU signals the full reboot +
readiness. Sometimes this process takes longer than expected. This is due
to a callback from ECU as soon as its ready.

50
Figure 36: To reboot any ECU, right click an ECU node and hit "Reboot ECU".

5.3.8 Read additional infos from ECU


As we implemented some native UDS calls to any ECU, we also thought, why
not reading additional information from the ECU which is already there.
Preconditions:
• Have an SVT_CURRENT or SVT_ECU loaded
• Have an active connection to the vehicle

Usage
• Right click an ECU node from the SVT and choose "Read serial number"
or "read context information" (see Figure 37). The information will be
displayed in a new dialog (see Figure 38 and Figure 39)

51
Figure 37: The serial number as well as additional context information can be
read from any ECU.

Figure 38: Context information from an ECU.

52
Figure 39: Serial number from an ECU.

5.4 EsysX 8HP ISN Reset


Even though this feature is partly implemented in EsysX, it is described under
IspiHost Admin features, as you need IspiHost Admin in order to do the reset.
Refer to subsubsection 5.1.2 for the feature description.

5.5 Remote ENET helper


To connect to a car which is connected to a client’s PC, you must to the follow-
ing:
• Connect to the clients PC over any VPN tool

• Start Remote ENET on your clients PC


• As soon as you see the car’s vin in the Remote ENET tool, click activate
• Connect your program, e.g. EsysX, over the gateway url option by putting
in the client pc VPN address

53
6 Update/Upgrade your EsysX License
This section describes what an update/upgrade is and how to update or upgrade
your current EsysX license.

6.1 Update
An update is mainly for implementing new psdz data mappings into your cur-
rent EsysX license. You can check our Changelog at https://esysx.com/
change-log/ if there is new mappings since you have bought your license.
An update also includes bug fixes or improvements for your license type.
To update your license, go to your Shop at https://esysx.com/shop/ and
buy our "Update" product. Put your license number in and make sure to read
the product notes. You will receive a purchase confirmation mail with notes on
what to do next. Please read them.
After your update is built, you will receive it per mail. Install the update
(see subsection 3.2) and you are good to go.

6.2 Upgrade
An upgrade is for extending your license’s features. It also includes bug fixes or
improvements for your current license type.
To upgrade your license, go to your Shop at https://esysx.com/shop/ and
buy "Upgrade" product. Put your license number in and make sure to read the
product notes. You will receive a purchase confirmation mail with notes on
what to do next. Please read them.
After your upgrade is built, you will receive it per mail. Install the update
(see subsection 3.3) and you are good to go.

6.3 FSCs
You can also buy FSC generations for NBTEvo ID4 and Route maps (life-
time codes are not supported for Route maps) for IspiHost Admin’s Navi FSC
Generator (see subsubsection 5.1.1). If you want to do so, go to our shop at
https://esysx.com/shop/ and buy the FSC product you need.
We have built a new feature into EsysX which lets you immediately add the
bought FSC generations to your IspiHost Admin.
• If you don’t have the "Refresh" button in the "Navi FSC Generator" (see
Figure 40) within IspiHost Admin, then you will get an EsysX Update
at no cost automatically. Just wait for us to send you the Update (see
subsection 3.2) and install it, then you can use your new FSC generations.
• If you already have the updated version, then open up IspiHost Admin
after you have bought the FSC product over our shop and click "Refresh".
Your counter should update and include the new generations.

54
Figure 40: If you don’t have the refresh button yet, you will get an updated
EsysX version at no cost automatically

55
7 FAQs
This section describes frequently asked questions (FAQs) and how to solve
them. Make sure to also check out our support page at https://esysx.com/
contact-us/ for more FAQs.
Where can i buy new FSC generations for IspiHost Admin?
Answer: Please check subsection 6.3.
How to update navi map definitions for the Navi FSC Generator in
IspiHost Admin?
Please check section 4.
Is it possible to upgrade a software license to a hardware/dongle
license?
Unfortunately, this is not possible.
I have an error installing EsysX
Please have a look at subsection 3.4. Your error may be covered there. If
not, do not hesitate to contact us over our page’s contact form.
Can I use EsysX on a VM?
Only hardware/dongle licenses do support VMs.
Where can I find my license number?
Click the question mark on top of IspiHost Admin.
Can I use EsysX on my Mac?
The dongle/hardware license version can be used on VM on Mac
If i get a new PC, can I use my software license on the new one?
Only dongle/hardware license supports multiple PCs. The software license
is tied to the PCs hardware on which you activated it
How can I get my free update?
Any license comes with one free update. To claim it, contact us over our
site’s contact page. There is no product in our shop to cover free updates.
For how long can i use my EsysX license? Does it expire?
No, EsysX does never expire.
KIS features do only show german descriptions. Where are the other
languages?
As BMW is a german manufacturer, they only added the german descrip-
tions to the KIS databases. We cannot manually translate thousands of de-
scriptions and must rely on the ones that are stored in the KIS databases.
KIS features do not show ENTD/NAVD node description
Make sure to keep your lookup.xml defined in IspiHost Admin up to date.
Sometimes, even the newest lookup file does not contain a gracenote db.
Then there is no way unless you add it manually.

56
After doing the backup, i have an error in my car: 801C01 - Vehicle
configuration data could not be read
As we are calling native Esys functions to read vehicle configuration data
which not every model equally supports, this error can appear and can be
safely ignored. It does not necessaraly mean, that your data is incomplete.
Only the log after completing the backup tells you, which files have been
successfully read and created.
After doing the backup, the report says that there has been an error
in VCM
Some Esys versions report an error even though there has not been any
and all files have been read and created successfully. The report highlights
in green what has been created. This is the main indicator for all files if
they have been successfully created.
KIS features did not load
Make sure, that you have choosen a valid psdz release. Also, KIS features
only fully support 17-11 and above. If your chosen psdz is below 17-11
then KIS information will fail while loading. If you’ve done everything
right and it still fails to load, try invalidating the cache so it gets reloaded
after restarting EsysX. If the error persists, write us a message and include
the log file from your Esys version.
SVT node shows "No description in KIS..."
Make sure, that the psdz you are using is at least as new as the psdz release
which was used for the SVT. This means that if a car was flashed with
2019-07-5xx then the psdz you need to use to have all descriptions must
be at least 2019-07-5xx. Also, sometimes the KIS truly does not contain
information for a specific SGBMID, even not for an older main, sub or
patch version of it. Then there is no way we can display a description for
it.

57

You might also like