​
Prerequisites

  • Have a Heex CLI
  • Have a USER_SECRET_KEY. Should be accessible in your personnal space on the heex cloud platform. If you already logged-in you don’t need to add the Api-Key in your command line.

​
Usage

SubcommandDescription
downloadDownload SDK package.
build-samplesBuild the SDK C++ samples.
generate-implementations-fileWill generate the implementations.json file based on all scripts you have in the implementations folder.
runStart the HeexSdk.
set-systemSet credentials and download systemConf.
replayPull a Docker image and run a bag play.

Usage:

./heex sdk SUBCOMMAND [--help]

​
How to download the SDK

Usage:

./heex sdk download --api-key <USER_SECRET_KEY>

This command downloads the SDK that corresponds to the detected platform.

The downloaded archive file will be named Heex_SDK_<version>_<os_version>_<arch_type>.zip. For example for the SDK version 2024_11_1 and Ubuntu 22.04 x86, the archive name will be Heex_SDK_2024_11_1_Ubuntu_22.04_x86_64.zip.

The flags that are available to achieve this command are the following:

  • --api-key: mandatory USER_SECRET_KEY.
  • --version: The version of the SDK to download (e.g., ‘2024.2.0’), default is the latest version.
  • --output-dir: The output path folder where the SDK will be saved (Default is current directory).
  • --unzip: Unzip the downloaded SDK package.

When using the unzip option, the output folder name will be name Heex_SDK_<version>.

​
How to build the SDK C++ samples

Usage:

./heex sdk build-samples

This command builds the SDK C++ samples. By default, all build operations use 1 job. For faster operations, you can specify the number of parallel jobs with —jobs flag. The generated executables are located in the folder samples/cpp.

The optional flags that are available to achieve this command are the following:

  • --path-to-sdk: If you don’t run from inside the SDK folder, you have to provide the /path/to/sdk/folder.
  • --jobs: Allow building with N jobs at once; default is 1 job.

MCAP samples:

By default, the MCAP samples are disabled and will not be built. To activate the MCAP samples build, edit the file samples/CMakeLists.txt and uncomment the MCAP lines. Additionnal dependencies are required and will be automatically downloaded during the build.

​
Generating the implementation.json file

If you intend to run our solution within the packaged SDK, you may want to automatically handle the running of your implementations. To do so, you’ll need to generate a implementations.json file which shall be generated using following command:

./heex sdk generate-implementations-file --path-to-sdk /path/to/sdk/folder

📝 Note:

Only implementations located inside the implementations folder are handled, any other script you have outside of this folder, you shall have to handle manually.

​
How to set up a system and launch Heex

The command ./heex sdk set-system will define system credentials and download the systemConf to the default path ~/<Heex_SDK>/kernel/systemConfs/systemConf.json.

Usage:

./heex sdk set-system --system-id <SYSTEM_ID> --path-to-sdk <Heex_SDK> --api-key <USER_SECRET_KEY>

The command ./heex sdk run will generate the implementations.json and launch Heex.

Usage:

/heex sdk run --path-to-sdk <Heex_SDK> --api-key <USER_SECRET_KEY>

​
How to play a bag and watch events in real time for a given system

The command ./heex sdk replay will pull a Docker image, install the latest Agent and run a bag play to watch events in real time for a given system. Replay will use the default bag if none is provided.

Flags available:

  • system-id: The system ID to use. [Required]
  • bag-path: The path to the bag to play.
  • os-version: The OS version to use. [default: Ubuntu_24.04]
  • arch-type: Docker image architecture to use for the replay. [default: x86]
  • api-key: The API key to use. [Required]
  • autorun: If set, start playback immediately and exit once done. [default: True]
  • api-url: Heex Cloud API base URL to use for fetching and reporting events.
  • poll-interval: Interval in seconds between polling attempts. [default: 30]

Once the bag is played, you can watch events in real time. If you have tmux installed, the terminal will be split into two panes: one for the bag play and one for the events. If you don’t have tmux installed, we’ll try to use the default terminal to display the bag play and the events in two separate windows. If you don’t have any of these, you’ll have to check for the new events in the heex cloud platform.

Usage:

/heex sdk replay --api-key <USER_SECRET_KEY> --system-id <SYSTEM_ID>

​
Getting Help

./heex sdk --help
./heex sdk download --help
./heex sdk build-samples --help
./heex sdk generate-implementations-file --help
./heex sdk run --help
./heex sdk set-system --help
./heex sdk replay --help