Installation guide for imperix CPP SDK

This page details the installation guide for the imperix CPP SDK. It provides clear steps to import the user template into the imperix Integrated Development Environment (IDE). This page also shows how to compile this template, which serves as a practical test to confirm that the software development environment has been installed correctly.

Installing the software

After registration, the CPP SDK installer can be downloaded directly from imperix’s website, at https://imperix.com/downloads/.

CPP SDK users should then execute the installer and follow the on-screen instructions.

Retrieving the user template

Launching the imperix IDE

The imperix C++ IDE can be launched by searching for “imperix C++ IDE” in the Windows Start menu or by using the desktop shortcut. The first launch of the IDE can be slower as the Eclipse-based environment must perform preliminary configurations.

The IDE will then prompt for the selection of a workspace directory. This directory serves as the local repository where Eclipse manages configuration preferences and projects. Clicking on Launch will complete the initialization process.

Workspace location dialog Installation guide for imperix CPP SDK

Once launched, the Eclipse environment will display the interface illustrated below.

Base Eclipse environment Installation guide for imperix CPP SDK

Importing the user template

As a first step, the base user template source code must be imported into the environment. Two versions of the user template are available, depending on the target hardware. The Gen4_template.zip must be used for the B-Box 4, while the Gen3_template.zip is required for the other imperix controllers, namely the B-Box RCP, the B-Box micro, and the B-Board PRO. By default, both templates are located in the root of the SDK installation directory at C:\imperix\CPP_SDK.

The steps below detail how to import the selected user template into the workspace:

Select File -> Import…

Importing an existing file into the Eclipse environment Installation guide for imperix CPP SDK

Under General, select Existing Projects into Workspace and click Next

Import existing project into workspace Installation guide for imperix CPP SDK

Check the box Select archive file and browse the installation directory to find the zip file BB4_CPP_Template.zip or BB3_CPP_Template.zip and click on Finish

Select an archive file Installation guide for imperix CPP SDK

Renaming the project

To rename the project:

  1. Right-click on the project, click Rename… (or press F2), and enter the new name
  2. It may be necessary to right-click on the project → Index → Rebuild

To rename the project with older CPP SDK versions, the following procedure should be followed. Due to an Eclipse bug, not following the procedure will lead to a resource is out of sync with the file system error.

  1. Right-click on the project, click Rename… (or press F2), and enter the new name
  2. Right-click on the project and click Properties (or press Alt+Enter)
  3. Click on C/C++ Build and select the Refresh Policy tab
  4. Delete the resource with the old project name
  5. Click Add Resource… and select the folder with the name of the project and click OK
  6. Click Apply and Close
  7. Right-click on the project → Index → Rebuild
Project properties

Validating the installation

Once the user template has been successfully imported, a test compilation can be executed to verify the proper configuration of the software installation.

Building the User Template

The compilation can be manually launched by clicking on the “Build” icon at the top left corner of the IDE, or by pressing “CTRL+B”. The console window displays build information as well as any errors. The executable is generated in the “debug” folder (.elf file)

Flashing the code into the device

The upload and flashing of the generated code onto the target are managed by Cockpit. To launch Cockpit, users can select the project in the project pane and click on the Launch in ‘Run’ mode icon, directly within the imperix C++ IDE, as shown in the screenshot below.

Installation guide for imperix CPP SDK

When the button Launch in ‘Run’ mode is clicked, the Cockpit launch configuration transmits ${project_loc} to Cockpit, this variable contains the path to the project. If no project is selected, then this variable is empty, and the above error message is displayed.

To avoid this issue, make sure your project is open and selected before clicking on the launch button.

If Cockpit opens automatically and prompts the user to create a new project, it can be concluded that the CPP SDK is correctly installed and fully operational. This concludes this installation guide for the imperix CPP SDK.

Further readings

It is highly recommended to read the following pages: