Install

Prerequisites

RemotiveTopology runs the topology with the help of docker containers that interact with each other. Thus, you need Docker. Make sure to follow the post install steps to be able to run docker without sudo.

RemotiveTopology also supports Podman as an alternative, simply replace docker with podman in all instructions.

To develop behavioral models for RemotiveTopology, you need Python 3.10 or later.

On Windows you need to use WSL2, follow the instructions below to get started.

RemotiveTopology setup

To use RemotiveTopology, your organization must have an active subscription. If your organization is already a customer of RemotiveLabs, a subscription is likely already in place. Access to the service requires logging in with your organizational credentials to verify the subscription.

Free 30 day trial: For new users who wish to evaluate RemotiveTopology, it’s possible to create a trial subscription. This trial provides temporary access to explore the features and capabilities of the service. Once the trial period expires, you need to contact RemotiveLabs to purchase a full subscription and continue using RemotiveTopology. Read more about RemotiveTopology free trial.

To login and optionally create a trial subscription:

1. Install the RemotiveCLI. Make sure to also follow the Authentication step and sign in using RemotiveCLI to use RemotiveTopology.

2. You should now be signed-in with RemotiveCLI and have a default organization configured.

If you don't have any default organization set you can run

      remotive cloud organizations default

3. Test your current RemotiveTopology subscription status with the following command.

      remotive topology subscription status
   You should see something like this

    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
4. Create a trial if you don't have any subscription

      remotive topology start-trial

If you subscription is expired, pricing information and to discuss your specific requirements, please reach out RemotiveLabs sales.

Verify installation

To verify that RemotiveTopology is correctly installed:

remotive topology version

This displays the current version of RemotiveTopology and the default versions that are used in runtime environments.

The first time this is run RemotiveTopology is automatically downloaded using docker. Subsequent runs are much faster.

WSL2 in Windows

At the moment prebuilt kernels for WSL doesn't include support for VCAN/VXCAN and SocketCAN drivers. Before following the Linux instructions you need to do some WSL2 specific setup, pick one of the 2 options.

1. Use RemotiveLabs public prebuilt kernel located here. This kernel also contains all kernel drivers available upstream located in the sub menu. All modules are statically linked. To use the prebuilt kernel do

wsl --shutdown
edit C:\Users\YOURWINDOWSLOGINNAME\.wslconfig

Modify the path to the location of your kernel

[wsl2]
kernel=C:\\Users\\<yourwindowsloginname>\\vmlinux_static_usb_drivers

2. Alternatively you can rebuild the kernel as shown here, make sure to also include vxcan and if you intend to attach hardware you need to select the proper driver in CAN USB interfaces --->. You are encouraged to select * over M to create a kernel where the modules are statically linked.

By experience you are advised to uninstall docker for desktop and instead use vanilla Ubuntu docker engine install instructions as shown here. Make sure to follow the post install steps to be able to run docker without sudo.

Once you get the kernel running follow all instructions for Linux.

If you need to attach real USB SocketCAN adapter to connect to a real CAN/LIN bus go here, Windows allows WSL2 to get passthrough access to the connected USB device.

Linux

To use CAN hardware (or vcan) you need to install the following:

1. Install can-utils

sudo apt update
sudo apt install can-utils

3. Install RemotiveBus or DockerCAN

RemotiveBus and DockerCAN are Docker plugins that enable CAN network communication between Docker containers and physical CAN buses. These are only available for Linux. Other platforms can emulate CAN traffic over UDP. Choose one of the following options:

• RemotiveBus: Installation instructions and more information can be found in the RemotiveBus documentation.

• DockerCAN Currently the default CAN driver, but is about to be replaced by RemotiveBus.

Download and install the latest version of DockerCAN from https://releases.remotivelabs.com/#docker_can/

mkdir dockercan
tar xvf dockercan-VERSION.tar.gz -C dockercan
cd dockercan
make
cd ..
rm -rf dockercan

Podman

When using Podman the best solution is to set the environment variable CONTAINER_ENGINE to podman, for example:

export CONTAINER_ENGINE=podman

To verify that it works simply run:

remotive topology version

Editor setup

RemotiveTopology uses yaml files to describe instances and platforms. It's strongly recommended that you configure RemotiveTopology json schema in your editor to make it easier to edit these files. There is also a separate recording json schema which is used when working with recordings.

Visual Studio Code

Install Red Hat yaml plugin

Add the following to your settings.json:

    "yaml.schemas": {
        "https://files.remotivelabs.com/remotive_topology/topology-0.15.schema.json":
        ["*.instance.yaml", "*.platform.yaml"],
        "https://files.remotivelabs.com/remotive_topology/recording-0.2.schema.json":
        ["*.recordingsession.yaml", "*.mapping.yaml"]
    },

Usage

Run the following to get further instructions:

remotive topology --help

See Getting started for next steps.

Important

It's important that you run all remotive topology commands at the root of your project folder. Read more about the RemotiveTopology workspace.