​
Prerequisites

  • Have a Heex CLI
  • Have a USER_SECRET_KEY. Should be accessible in your personnal space on the heex cloud platform.

​
Usage

SubcommandDescription
addExtract all the signals from provided bag, create all the signals on the cloud, group them into a Data Source and associate this Data Source to given system. Currently we only support mcap format.
getProvides a list of available datasources.

Usage:

./heex datasource SUBCOMMAND [--help]

With this single command, you shall:

  1. Extract all the topics out of the bag. They shall be separated into standard topics and custom topics, as we currently only support the creation of signals based off standard topics.
  2. Create a Data Source.
  3. Bind it to your system.
  4. Create each individual signal and link them to the Data Source.
  5. Update your system’s implementation to include the Data Source.

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

  • --api-key: provide your USER_SECRET_KEY. It is mandatory if you don’t use the --info-only flag.
  • --from-bag: The path to the bag file you want to extract the signals from.
  • --system-id: System id on which the Data Source will be created. It is mandatory if you don’t use the --info-only flag.
  • --datasource-name: this one is optional. If you don’t provide it, it shall take the name of your bag file.
  • --info-only: If set, it will only list the signals that would be created into your terminal, without generating them on the cloud.

Usage:

./heex datasource add --from-bag BAG_PATH --api-key <USER_SECRET_KEY> --system-id "s-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

​
How to get Data Source infos

This command allows you to retrieve datasources based on Data Source IDs or Data Source name. Note that all filters are optional, if no filters are provided, it will return all datasources found on page 1. Keep in mind that only a filter at a time can be applied, so if Data Source id is used , datasource-name cannot be used.

Available subcommands:

  • --api-key: mandatory USER_SECRET_KEY.
  • --datasource-id: The ID of the Data Source you want to retrieve. Multiple can be specified: --datasource-id ID1 --datasource-id ID2. It is exclusive with option name.
  • --name: The name of the Data Source to retrieve. It is exclusive with datasource-id option.
  • --output-file: If set, it’ll provide the result in a json format in a file generated at given path. Make sure you provide the ‘.json’ extension.

Usage:

./heex datasource get --api-key <USER_SECRET_KEY> --system-id "s-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" \
--trigger-id "t-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --datasource-id "d-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" --datasource-id "d-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

​
Getting Help

./heex datasource --help
./heex datasource add --help
./heex datasource get --help