RemotiveLabs

https://docs.remotivelabs.com/docs/
Admin
RemotiveLabs is a lightweight automotive software development and testing platform for vehicle...
Tokens:69,520
Snippets:1,457
Trust Score:7.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start and Stop Command Examples

Source: https://docs.remotivelabs.com/docs/remotive-bus/plugins

JSON payloads sent to plugins for network lifecycle management.

```json
{
	"version": 1,
	"action": "start",
	"bus": {
		"type": "vcan",
		"device": "mybus",
		"baudrate": 19200,
		"host_device": "myhostbus",
		"plugin": {
			"driver": "mypluginid",
			"name": "My Can"
		}
	}
}
```

```json
{
	"version": 1,
	"action": "stop",
	"bus": {
		"type": "vcan",
		"device": "mybus",
		"baudrate": 19200,
		"host_device": "myhostbus",
		"plugin": {
			"driver": "mypluginid",
			"name": "My Can"
		}
	}
}
```

--------------------------------

### Plugin Configuration Example

Source: https://docs.remotivelabs.com/docs/remotive-bus/plugins

Example configuration for a container network using a plugin.

```json
{
	"type": "vcan",
	"device": "mybus",
	"baudrate": "19200",
	"host_device": "myhostbus",
	"plugin.driver": "mypluginid",
	"plugin.name": "My Can"
}
```

--------------------------------

### Workspace file structure example

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/errors

Example directory structure for a project using instances and platform files.

```text
./my_project/  
├── instances  
│   └── main.instance.yaml  
└── platform  
    ├── databases  
    │   └── something.dbc  
    └── main.platform.yaml  
```

--------------------------------

### Install rpm package

Source: https://docs.remotivelabs.com/docs/remotive-cli/installation

Install the CLI tool using dnf.

```bash
sudo dnf install remotivelabs-cli  

```

--------------------------------

### interfaces.json Configuration Example

Source: https://docs.remotivelabs.com/docs/remotive-broker/configuration

Example of an interfaces.json file defining CAN namespaces and their associated database paths.

```json
{
  "chains": [  
    {  
      "namespace": "my_can0",  
      "type": "can",  
      "database": "databases/can.dbc",  
      "device_name": "can0"  
    },  
    {  
      "namespace": "my_can1",  
      "type": "can",  
      "can_physical_channel_name": "/foo/bar",  
      "database": "databases/can.arxml",  
      "device_name": "can1"  
    }  
  ]
}
```

--------------------------------

### Start trial subscription

Source: https://docs.remotivelabs.com/docs/remotive-topology/install

Initiates a 30-day trial subscription for RemotiveTopology.

```bash
   remotive topology start-trial  
```

--------------------------------

### Launch RemotiveStudio

Source: https://docs.remotivelabs.com/docs/remotive-studio/getting-started

Basic commands to start RemotiveStudio with a specified workspace directory.

```bash
remotive studio <path>
```

```bash
remotive studio .
```

```bash
remotive studio ~/repos/remotivelabs-topology-examples
```

--------------------------------

### Configuration Directory Structure

Source: https://docs.remotivelabs.com/docs/remotive-broker/configuration

Example of a standard configuration folder layout containing databases and the required interfaces.json file.

```text
my-configuration/  
├── databases/  
│   ├── can.dbc  
│   └── can.arxml  
└── interfaces.json  
```

--------------------------------

### Install or upgrade deb package

Source: https://docs.remotivelabs.com/docs/remotive-cli/installation

Update package lists and install the CLI tool.

```bash
sudo apt update  
sudo apt install remotivelabs-cli  

```

--------------------------------

### Install via pipx

Source: https://docs.remotivelabs.com/docs/remotive-cli/installation

Install the CLI tool into an isolated virtual environment using pipx.

```bash
pipx install remotivelabs-cli  

```

--------------------------------

### Generate and run a topology instance

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/recordings/usage

Generates the build artifacts and starts the instance using Docker Compose.

```bash
remotive topology generate -f <target.instance.yaml> build
docker compose -f build/<instance>/docker-compose.yml
```

--------------------------------

### Install RemotiveBus via APT

Source: https://docs.remotivelabs.com/docs/remotive-bus/install

Add the RemotiveLabs repository and install the remotivebusd package on Debian or Ubuntu systems.

```bash
curl -fsSL \
  https://packages.remotivelabs.com/apt-repo-signing-key.gpg \
  | sudo gpg --dearmor -o /usr/share/keyrings/remotivelabs-apt.gpg

echo "deb [signed-by=/usr/share/keyrings/remotivelabs-apt.gpg] \
  https://packages.remotivelabs.com remotivelabs-apt main" \
  | sudo tee /etc/apt/sources.list.d/remotivelabs.list

sudo apt update
sudo apt install remotivebusd
```

--------------------------------

### Example token file structure

Source: https://docs.remotivelabs.com/docs/cloud/Guides/migrate-from-apikeys

The expected JSON format of a personal access token file.

```json
{
  "expires": "2033-09-12",
  "token": "92B56F9C-A5869F38-F24DEBD2-09DFB027-3C760E73-243F3949-63ED57FF-E90A95C1",
  "created": "2023-09-12T07:02:34.521Z",
  "name": "EB39AFB2492D6D94"
}
```

--------------------------------

### Example subscription status output

Source: https://docs.remotivelabs.com/docs/remotive-topology/install

Displays the expected output format when checking the subscription status.

```text
 RemotiveTopology subscription status  
   Account:      me@mycompany.com  
   Organization: My Company (id: xxx)  
   Type:         trial  
   Status:       active  
   Start date:   2025-02-01  
   End date:     2026-03-01  
```

--------------------------------

### Start RemotiveBroker services

Source: https://docs.remotivelabs.com/docs/remotive-broker/getting-started/linux-computer

Launch the services using Docker Compose. Use the detached mode flag to run them in the background.

```bash
docker compose up
```

```bash
docker compose up -d
```

--------------------------------

### Inspect platform topology output

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/platform

Example output showing how ECUs are automatically connected to channels after defining a DBC database.

```bash
$ remotive topology show platform topology/simple.platform.yaml  
---
schema: remotive-topology-platform:0.15  
channels:  
  DriverCan0:  
    type: can  
    can_physical_channel_name: DriverCan0  
    database: .../databases/driver_can.dbc  
ecus:  
  BCM:  
    channels:  
      DriverCan0:  
        database: .../databases/driver_can.dbc  
  SCCM:  
    channels:  
      DriverCan0:  
        database: .../databases/driver_can.dbc
```

--------------------------------

### Install deb package repository key

Source: https://docs.remotivelabs.com/docs/remotive-cli/installation

Download and store the GPG signing key for the apt repository.

```bash
curl -fsSL https://packages.remotivelabs.com/apt-repo-signing-key.gpg \
  | sudo gpg --dearmor -o /usr/share/keyrings/remotivelabs-apt.gpg  

```

--------------------------------

### Run topology in interactive mode

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/running

Starts the topology and keeps it running for manual testing or development.

```bash
docker compose -f build/mytopology/docker-compose.yml up  
```

```bash
docker compose -f build/mytopology/docker-compose.yml down  
```

--------------------------------

### Run topology with specific profile

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/instance

Commands to start the topology using a specific Docker Compose profile.

```bash
docker compose -f build/mytopology/docker-compose.yml --profile tester up  
```

```bash
docker compose -f build/mytopology/docker-compose.yml --profile tester up --abort-on-container-exit  
```

--------------------------------

### Start Docker Compose Services

Source: https://docs.remotivelabs.com/docs/remotive-topology/tools/docker

Commands to initialize services defined in the compose file, with options for detached mode or targeting specific services.

```bash
docker compose -f docker-compose-turn-signals-can.yml up --build
```

```bash
docker compose -f docker-compose-turn-signals-can.yml up --build -d
```

```bash
docker compose -f docker-compose-turn-signals-can.yml up --build bcm
```

--------------------------------

### Mockup ARXML database structure

Source: https://docs.remotivelabs.com/docs/remotive-broker/configuration/can

An example of the internal structure of an ARXML file, showing the hierarchy for physical channels.

```xml
...  
  <AR-PACKAGES>  
      ...  
      <AR-PACKAGE>  
        <SHORT-NAME>ExamplePackage</SHORT-NAME>  
        <ELEMENTS>  
            <CAN-CLUSTER>  
              <SHORT-NAME>ExampleCanCluster</SHORT-NAME>  
              <CAN-CLUSTER-VARIANTS>  
                  <CAN-CLUSTER-CONDITIONAL>  
                      <PHYSICAL-CHANNELS>  
                          <CAN-PHYSICAL-CHANNEL>  
                              <SHORT-NAME>ExampleCANChannel</SHORT-NAME>  
                              <FRAME-TRIGGERINGS>  
                                  <CAN-FRAME-TRIGGERING>  
                                  ...  
                                  </CAN-FRAME-TRIGGERING>  
                              </FRAME-TRIGGERINGS>  
                          </CAN-PHYSICAL-CHANNEL>  
                      </PHYSICAL-CHANNELS>  
                  </CAN-CLUSTER-CONDITIONAL>  
              </CAN-CLUSTER-VARIANTS>  
            </CAN-CLUSTER>  
        </ELEMENTS>  
      </AR-PACKAGE>  
      ...  
  </AR-PACKAGES>  
...
```

--------------------------------

### Start and stop a cloud broker

Source: https://docs.remotivelabs.com/docs/remotive-cli/samples

Automates the creation, inspection, and deletion of a cloud broker. Requires setting organization and project environment variables.

```bash
#!/usr/bin/env bash  
  
set -e  
  
export REMOTIVE_CLOUD_ORGANISATION=my-organisation-uid  
export REMOTIVE_CLOUD_PROJECT=my-project-uid  
  
export BROKER_NAME=my-broker  
  
# If you already logged on you can omit this  
remotive cloud auth login  
  
remotive cloud brokers create "$BROKER_NAME"  
  
broker_details=$(remotive cloud brokers describe $BROKER_NAME)  
broker_name="$(echo "$broker_details" | jq --raw-output .name)"  
broker_url="$(echo "$broker_details" | jq --raw-output .url)"  
echo "$broker_url"  
for key in $(echo "${broker_details}" | jq -r '.keys[]'); do  
  echo "Broker $broker_name has API-KEY: $key"  
done  
the_key=$(echo "$broker_details" | jq -r '.keys[0]')  
echo "$the_key"  
  
# List available signals  
remotive broker signals list --url "$broker_url" --api-key "$the_key" | jq .  
  
# Stop broker  
echo "Stopping broker $broker_name"  
remotive cloud brokers delete "$broker_name"
```

--------------------------------

### Create a project

Source: https://docs.remotivelabs.com/docs/cloud/Project/Projects

Initialize a new project within an organization.

```bash
$ remotive cloud projects create --organisation my-organisation --project-uid my-new-project  
```

--------------------------------

### Verify CLI installation

Source: https://docs.remotivelabs.com/docs/remotive-cli/installation

Check the installed version of the Remotive CLI.

```bash
remotive --version  
```

```text
remotivelabs-cli 0.x.x (python 3.12.11; linux; native)  
```

--------------------------------

### Show instance configuration

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/errors

Command to inspect instance configuration for troubleshooting LIN hardware port conflicts.

```bash
remotive topology show instance your-instance-file.instance.yaml  
```

--------------------------------

### Manual Installation of RemotiveBus

Source: https://docs.remotivelabs.com/docs/remotive-bus/install

Unpack and install the RemotiveBus package manually from a downloaded tarball.

```bash
mkdir remotivebus
tar xvf remotivebus-VERSION.tar.gz -C remotivebus
cd remotivebus
make
cd ..
rm -rf remotivebus
```

--------------------------------

### Verify RemotiveTopology installation

Source: https://docs.remotivelabs.com/docs/remotive-topology/install

Check the installed version of RemotiveTopology and default runtime environment versions.

```bash
remotive topology version  
```

--------------------------------

### List sample recordings

Source: https://docs.remotivelabs.com/docs/cloud/Project/Recordings

Displays available sample recordings that can be imported into a project.

```bash
$ remotive cloud samples list  
```

--------------------------------

### Instantiate a recording session

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/recordings/usage

Creates a topology instance from a recording session configuration file.

```bash
remotive topology recording-session instantiate <source.recordingsession.yaml> <target.instance.yaml>
```

--------------------------------

### Create and Configure Service Account via CLI

Source: https://docs.remotivelabs.com/docs/remotive-topology/ci

Commands to define project variables, create a service account with specific roles, generate an access token, and activate the account for use.

```bash
# Automatically picked up as project  
export REMOTIVE_CLOUD_PROJECT=my-project  
export SA_NAME=gh-action-runner  
  
remotive cloud service-accounts create $SA_NAME --role org/topologyRunner  
  
# Create the access token for the service account  
remotive cloud service-accounts tokens create --service-account $SA_NAME  
  
# This will show all your accounts, including service-accounts. Select the number of your service account.  
remotive cloud auth activate  
    ┏━━━┳━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓  
    ┃ # ┃ Active ┃ Type ┃ Token ID         ┃ Account                                        ┃ Created    ┃ Expires    ┃  
    ┡━━━╇━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩  
    │ 1 │        │ sa   │ 63F172EF3082FD47 │ my-docs-test-sa@sa.my-project.remotivecloud.com│ 2026-05-06 │ 2027-05-06 │  
    │ 2 │ ✅     │ user │ 2C63465D9688B0AF │ dev@remotivelabs.com                           │ 2026-04-10 │ 2027-04-10 │  
    └───┴────────┴──────┴──────────────────┴────────────────────────────────────────────────┴────────────┴────────────┘  
    👉 To get the access token for your activated account, use remotive cloud auth print-access-token  
  
  
# Now, the access token that will be used in REMOTIVE_CLOUD_AUTH_TOKEN  
remotive cloud auth print-access-token  
    sax.x/xxxx-xxxxxx-xxxxx-xxxxx
```

--------------------------------

### Install Linux Kernel Modules

Source: https://docs.remotivelabs.com/docs/remotive-bus/install

Install the necessary kernel modules for SocketCAN support on Ubuntu systems.

```bash
sudo apt install linux-modules-extra-$(uname -r)
```

--------------------------------

### Install RemotiveBus via DNF

Source: https://docs.remotivelabs.com/docs/remotive-bus/install

Configure the repository and install the remotivebusd package on Red Hat, CentOS, or Fedora systems.

```bash
sudo tee /etc/yum.repos.d/remotivelabs.repo > /dev/null <<EOF
[remotivelabs]
name=Remotivelabs
baseurl=https://packages.remotivelabs.com/yum/remotivelabs-yum
enabled=1
EOF

sudo dnf install remotivebusd
```

--------------------------------

### Generate instance with additional settings

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/recordings/usage

Applies multiple instance configuration files during the generation process.

```bash
remotive topology generate -f <target.instance.yaml> -f can_over_udp.instance.yaml build
```

--------------------------------

### Import a sample recording

Source: https://docs.remotivelabs.com/docs/cloud/Project/Recordings

Imports a specific sample recording into the target project.

```bash
$ remotive cloud samples import --project TEXT RECORDING_SESSION  
```

--------------------------------

### Create and view access tokens

Source: https://docs.remotivelabs.com/docs/cloud/Project/Projects

Generate a service account access token and view the structure of the resulting JSON token file.

```bash
$ remotive cloud service-accounts tokens create \
  --service-account my-service-account \
  --project beamyhack  
Secret token written to /HOME/.config/.remotive/service-account-my-service-account-87AEC65AFA381BC9-token.json  
```

```json
{"version":"1.1",
  "type":"service_account",
   "token":"sa1.0/xxxx-xxxxx-xxxxxx-xxxxxx-xxxxx",
   "expires":"2027-05-06",
   "created":"2026-05-06",
   "name":"EB6CF763ECC5A60B",
   "account":{"email":"my-docs-test-sa@sa.xxxxx.remotivecloud.com"}}
```

--------------------------------

### Upgrade rpm package

Source: https://docs.remotivelabs.com/docs/remotive-cli/installation

Upgrade the existing CLI tool installation using dnf.

```bash
sudo dnf upgrade remotivelabs-cli  

```

--------------------------------

### Configure remotivebus driver

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/errors

Example configuration for the remotivebus driver with a valid host_device name.

```yaml
schema: remotive-topology-instance:0.15  
  
channels:  
  DriverCan0:  
    type: can  
    driver:  
      type: remotivebus  
      config:  
        type: can  
        device: drivercan  
        host_device: host-drivercan  
```

--------------------------------

### Inspect Topology Instance

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/instance

Use this command to view the instantiated parts of a topology and any applied defaults.

```bash
remotive topology show instance <filename>
```

--------------------------------

### Configure CAN UDP driver

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/errors

Examples for default and explicit UDP broadcast configuration for CAN channels.

```yaml
schema: remotive-topology-instance:0.15  
  
channels:  
  DriverCan0:  
    type: can  
    driver:  
      type: upd  
```

```yaml
schema: remotive-topology-instance:0.15  
  
channels:  
  DriverCan0:  
    type: can  
    driver:  
      type: upd  
      port: 14000  
      subnet: 10.19.1.0/24  
      target_host: 230.0.0.1  
```

--------------------------------

### View CLI license request help

Source: https://docs.remotivelabs.com/docs/remotive-broker/request-license?method=app

Displays help information for the license request command.

```bash
remotive broker license request --help
```

--------------------------------

### Include platform in instance.yaml

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/errors

Demonstrates the incorrect versus correct structure for including platform files.

```yaml
schema: remotive-topology-instance:0.15  
  
includes:  
  - ./my.platform.yaml  

```

```yaml
schema: remotive-topology-instance:0.15  
  
platform:  
  includes:  
    - ./my.platform.yaml  

```

--------------------------------

### Initialize a RemotiveTopology workspace

Source: https://docs.remotivelabs.com/docs/remotive-topology/workspace

Sets up the workspace in the current directory to enable caching and persistent configuration.

```bash
cd remotivelabs-topology-examples  
remotive topology workspace init  
```

--------------------------------

### Example invalid recording response

Source: https://docs.remotivelabs.com/docs/cloud/Project/Recordings

JSON output showing an error state for an invalid recording file.

```json
[
  {
    "fileName": "my-invalid-recording.zip",
    "displayName": "my-invalid-recording.zip",
    "metadata": {
      "error": true,
      "message": "(Error) invalid signature: 0x474e5089"
    },
    "sizeInBytes": 103443
  }
]
```

--------------------------------

### Display CLI help

Source: https://docs.remotivelabs.com/docs/remotive-cli/installation

View available commands and options for the Remotive CLI.

```bash
remotive --help  
```

```text
Usage: remotive [OPTIONS] COMMAND [ARGS]...  
  
 Welcome to RemotiveLabs CLI - Simplify and automate tasks for cloud resources and brokers  
 For documentation - https://docs.remotivelabs.com  
  
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────╮  
│ --version                     Print current version                                                             │  
│ --install-completion          Install completion for the current shell.                                         │  
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.  │  
│ --help                        Show this message and exit.                                                       │  
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯  
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────╮  
│ tui        Explore remotive-cli and generate commands with this textual user interface application              │  
│ topology   Interact and manage RemotiveTopology resources                                                       │  
│ broker     Manage a single broker - local or cloud                                                              │  
│ cloud      Manage resources in RemotiveCloud                                                                    │  
│ connect    Integrations with other systems                                                                      │  
│ tools      CLI tools unrelated to cloud or broker                                                               │  
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯  
```

--------------------------------

### Run topology commands from project root

Source: https://docs.remotivelabs.com/docs/remotive-topology/usage/errors

Demonstration of running commands from the correct directory to resolve path resolution errors.

```bash
cd my_project/instances  
remotive topology show instance ./main.instance.yaml  
```

```bash
cd my_project  
remotive topology show instance ./instances/main.instance.yaml  
```
Tokens:
Raw