Prerequisites

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

Usage

SubcommandDescription
createCreates a new signal.

Usage:

./heex signal SUBCOMMAND [--help]

How to create a new signal for a given Data Source

With this single command, you will be able to create a new signal and associate it with a given data source.

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

  • --api-key: Provide your USER_SECRET_KEY.
  • --datasource-id: ID of the involved datasource [required].
  • --signal-name: Signal name to create [required].
  • --signal-type: Type of the signal. Check help for available types [required].
  • --signal-unit: Unit of the signal. Check help for available units [optional].
  • --ros-topic-type: Type of ros topic [optional].

Usage:

./heex signal create --api-key <USER_SECRET_KEY> --datasource-id <DATASOURCE_ID> --signal-name <SIGNAL_NAME> \
--signal-type <SIGNAL_TYPE> --signal-unit <SIGNAL_UNIT>

If you don’t know the Data Source Id, you can check Get Data Source to get it.

Getting Help

./heex signal --help
./heex signal create --help