Skip to main content

Install

Prerequisites​

RemotiveTopology runs the topology with the help of docker containers that interact with each other. Thus, you need Docker. 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.9 or later.

All commands are run using RemotiveCLI version 0.5.0 or later. Make sure to install using pipx, see more details RemotiveCLI installation.

pipx install remotivelabs-cli
pipx upgrade remotivelabs-cli

On Windows you need to use WSL2.

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 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. If you're not part of an existing organization, create a free account at RemotiveCloud. This automatically creates an organization.
  2. Install the RemotiveCLI.
  3. Use RemotiveCLI to log in to your account, then create your trial license. 
       remotive cloud auth login
  4. Create a trial license if necessary. 
       remotive topology start-trial

For 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.

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
  1. 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.14.schema.json":
        ["*.instance.yaml", "*.platform.yaml"],
        "https://files.remotivelabs.com/remotive_topology/recording-0.1.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.