Subcommand | Description |
---|---|
get | Retrieve signal details for the given signal id. |
list | Retrieve signal list for the provided filters. |
update | Update an existing signal. |
create | Creates a new signal. |
create-template-file | Creates an empty template file that can be used as input for the create or update command. |
delete | Delete a signal with a given ID. |
--system-id
ID of the involved system.--trigger-id
ID of the involved trigger.--datasource-id
ID of the involved datasource. Multiple can be given: e.g. —datasource-id 1 —datasource-id 2 —datasource-id 3--signal-id
ID of the involved signal. Multiple can be given: e.g. —signal-id 1 —signal-id 2 —signal-id 3--signal-name
Name of the signal to retrieve details for.--datasource-name
Name of the datasource to retrieve details for.--owner-id
Owner ID of the signal to retrieve details for.--output-file
The result will be saved into this provided filepath. The output format is json, so please provide a filepath with that format:/path/to/file.json--output-file
flag. If the provided path doesn’t exist, it will be created. See example below where several filters can be used at the same time:
--api-key
: Provide your USER_SECRET_KEY.--datasource-id
: ID of the involved datasource [required if not using a file].--signal-name
: Signal name to create [required if not using a file].--signal-type
: Type of the signal. Check help for available types [required if not using a file].--signal-unit
: Unit of the signal. Check help for available units [optional].--ros-topic-type
: Type of ros topic [optional].--input-file
: Full path to the input file to use, it has to be a .json file, example : /path/to/input.json--folder-path
is provided, the template will be saved in the current directory.
Usage:
name
, type
and datasource_id
are required fields, other fields can be removed. To see possible values for type
and unit
you can use the --help
flag.
--signal-id
to specify the signal to update, which is required.
If you want to update a signal using a json file, you can generate a template file using command below:
Usage:
signal-id
. If the signal is linked to any trigger, it is not possible to delete: you need to unlink it from the trigger(s) first and then try again.
Usage: