Quick Start

This quick start is intended for intermediate to advanced developers. For a gentler intro to EHANDBOOK Container-Build, head to our Tutorials!

Download, Installation & License Setup

Download

EHANDBOOK Container-Build is not yet available as trial from the ETAS Download Server. Please contact your ETAS Sales office for obtaining the software.

Installation

To install the EHANDBOOK Container-Build tools:

  1. Unzip the download package into a directory of your choice. As standard directory, it is recommended to install ETAS tools under C:\ETAS

  2. Run EHANDBOOK-Container-Build_x.x.x_License-Management_setup.exe with administrator rights

License setup

To activate your license:

  1. Launch the ETAS License Manager (LiMa) from the Windows start menu (e.g., type ETAS License Manager in the search field)

  2. Go to the menu Device → Online Activation

  3. Paste the Activation ID that you have received from ETAS (e.g., via email)

ETAS License Manager

  1. Check that the license features for EHANDBOOK Container-Build are available (green checkmark)

ETAS License Manager

You’re now all set up and good to go!

Quick Start Demos

You can download the sources for our Quick Start Demo from this link. The demo comprises three functions with an ASCET 6 model, a Simulink model and C-Code.

ehb nav quick start demo screenshot

Graphical User Interface (GUI)

Launch

The EHANDBOOK Container-Build tool-chain provides a graphical user interface (GUI). To launch the GUI, navigate to the installation directory (e.g., C:\ETAS\EHANDBOOK-Container-Build_<Version>-Windows) and double-click on eHandbookCB.exe.

GUI

Generate

To generate an EHANDBOOK Container using the GUI, you have to

  1. Specify an input folder with the sources that shall be converted

  2. Specify an output folder where the EHANDBOOK Container shall be generated to

  3. Provide a name for the EHANDBOOK Container file that will be generated

Click the Generate button to start generating an EHANDBOOK Container.

After the EHANDBOOK Container is successfully generated, you can either directly open it in EHANDBOOK-NAVIGATOR or open the output folder in Windows Explorer.

Additional options

The other options provided by the GUI are optional:

  • SIMLIB path can be used to specify the path to a directory with Simulink libraries. Learn more about this option here.

  • Styling folder can be used to provide a custom styling for the EHANDBOOK Container. Learn more about this option here.

  • Generate SVG can be used if the textual documentation contains links to interactive models. Learn more about this option here.

  • Allow MATLAB connection can be used to use MATLAB as additional tool to generate images for masked blocks. Learn more about this option here.

Command-Line Interface (CLI)

Launch

EHANDBOOK Container-Build tools can also be operated from command-line. In fact, when it comes to automating EHANDBOOK Container-Build, the command-line interface is the perfect way to do so.

  1. Open a command window, e.g. by typing cmd in the Windows search field. Press btn:[Enter] to open the command window.

  2. Navigate to the directory where EHANDBOOK Container-Build tools are installed. E.g., cd C:\ETAS\EHANDBOOK-Container-Build_<Version>-Windows.

  3. Run the following command to show the command-line options

eHandbookCB.exe -help
Show help for EHB-CB command-line tool

Refer to the CB Usage for more details on the command-line options.

Generate

To generate an EHANDBOOK Container using the CLI, you have to pass the following arguments to eHandbookCB.exe

  1. -i <path to input folder> specifies the sources that shall be converted

  2. -o <path to output folder> specifies where the EHANDBOOK Container shall be generated to

  3. -n <name> for the EHANDBOOK Container file that will be generated

C:\ETAS\EHANDBOOK-Container-Build_10.0.0-Windows\eHandbookCB.exe ^
-i "<path to input folder>" ^
-o "<path to output folder>" ^
-n "<name>"

Create an EHANDBOOK project

An EHANDBOOK project can contain one or more containers. The created project will be saved as .ehbp format.

To generate an EHANDBOOK Project, you have to pass the following arguments to eHandbookCB.exe

  1. -application com.etas.ehcb.project.application

  2. -i <path to input folder> specifies the directory containing ehb containers

  3. -o <path to output folder> specifies where the EHANDBOOK Project shall be generated

  4. -n <name> for the EHANDBOOK Project file that will be generated

C:\ETAS\EHANDBOOK-Container-Build_10.0.0-Windows\eHandbookCB.exe ^
-application com.etas.ehcb.project.application ^
-i "<path to input folder>" ^
-o "<path to output folder>" ^
-n "<name>"

  • The creation of EHANDBOOK projects does not include support for encrypted (.ehbcrypt) containers.

  • If there are duplicate containers in the input, whether they have the same name or not, only one of these containers will be taken into account.

Please ensure that the arguments do not end with a backslash '\' as CLI does not support this.

For example, the following is considered as an invalid argument:

-i "C:\Windows\Users\input\"