APIs, concepts, guides, and more
Install RMP for Linux (Ubuntu)

Install and configure RMP and its necessary components in Linux distribution: Ubuntu.


Recommendations

  • Ubuntu familiarity.
  • Terminal app familiarity.
  • Follow only sections that apply to you.


1️⃣ Operating System

RMP can run on Linux Ubuntu. Ensure you install a release that supports real-time kernel enabling.

System Requirements

  • ​2 GHz dual-core processor or better
  • 4 GB system memory
  • 25 GB of free hard drive space
  • A USB and USB port for the installer media
  • Internet access is helpful

Supported Versions
See Ubuntu's real-time releases here.

1. Installation

  1. Download the Ubuntu 24.04 LTS (or your Ubuntu real-time release) ISO image.
  2. Create a bootable USB flash drive with balenaEtcher or similar.
  3. Open BIOS settings on your target PC.
  4. Boot your target PC from the USB flash drive.
  5. Once you boot from the USB that contains the Ubuntu image, Select Try or Install Ubuntu.
  6. Once the Ubuntu desktop is open, go through the configuration Install RELEASE wizard.
  7. Click Install.

Note: if updates are available for your OS or OS Installer, we recommend installing them.


Ubuntu OS should be installed.


2️⃣ Real-time kernel

For RMP to run in a real-time deterministic manner, the real-time kernel must be enabled.

Resource
Follow Ubuntu's guide here.

System Requirements

  • OS: Ubuntu
  • Hardware: 64-bit processor with x86_64 (“amd64” architecture)
  • Package/subscription: Ubuntu Pro
  • Internet access
  • Administrator “root” privileges

1. Licensing

To enable the real-time kernel you must have an Ubuntu Pro subscription.

  1. Get your token from your Ubuntu Pro Dashboard.
  2. Open the Terminal app.
  3. License your PC using the following command:
    sudo pro attach {TOKEN_FROM_DASHBOARD}

2. Latency Testing (recommended)

On real-time systems, one of the most important metrics is the maximum latency. This is the maximum time it takes for a system to respond to an event. It’s important because it can be used to determine if a system can respond to an event in a timely manner. In other words, it can be used to determine whether a system can meet the required deadlines.

Resource
Follow Ubuntu's guide here.

3. Real-time Enabling

The Real-time Ubuntu kernel is installed using the APT package manager. Install Real-time Ubuntu and automatically select the right version for your OS and processor:

  1. Open the Terminal app.
  2. Enable Ubuntu Real-time using the command that applies to your system:
    • Generic: sudo pro enable realtime-kernel
    • Raspberry Pi: sudo pro enable realtime-kernel --variant=raspi
    • Intel IOTG: sudo pro enable realtime-kernel --variant=intel-iotg
  3. Enter y (Yes) to all prompts until the command exits.
  4. Reboot to complete real-time installation.

4. Latency Testing (recommended)


Ubuntu Real-time kernel should be enabled.


3️⃣ BIOS & Kernel Optimization

This step is optional. If your systems' latency did not perform well, you may be able to optimize it for better real-time performance.

Note
Different systems have varying BIOS and/or Kernel options that can improve performance. RSI sells hardware optimized for real-time performance, but if you wish to use your own hardware, below are some guides you can follow to tune your system for optimal real-time performance.

BIOS

Ubuntu's guide: Tuning a real-time kernel | BIOS options

Kernel

Ubuntu's guide: How to configure CPUs for real-time processing


4️⃣ RMP Motion Controller

System Requirements

  • Internet access
  • Administrator “root” privileges
  • YubiKey (USB)

1. Installation

Install the latest RMP Motion Controller with its necessary packages.

  1. Open the Terminal app.
  2. Download and install the RMP and necessary packages using the command that applies to your system:

    • for Desktop

      cd ~
      ## Packages
      sudo dpkg --add-architecture i386
      sudo apt-get update
      sudo apt-get install -y libcap2:i386
      ## RMP
      sudo wget https://downloads.roboticsys.com/rmp/linux/rmp_10.5.4-1_amd64.deb
      sudo dpkg -i rmp_10.5.4-1_amd64.deb
      sudo apt-get install -f
      ## RapidSetupX UI
      sudo wget https://downloads.roboticsys.com/rapidsetupx/release/rapidsetupx-10.5.4-lin.zip -O /rsi/rapidsetupx-10.5.4-lin.zip
      sudo unzip /rsi/rapidsetupx-10.5.4-lin.zip -d /rsi
      sudo rm /rsi/rapidsetupx-10.5.4-lin.zip

    • for Headless

      cd ~
      ## Packages
      sudo dpkg --add-architecture i386
      sudo apt-get update
      sudo apt-get install -y libcap2:i386
      ## RMP
      sudo wget https://downloads.roboticsys.com/rmp/linux/rmp_10.5.4-1_amd64.deb
      sudo dpkg -i rmp_10.5.4-1_amd64.deb
      sudo apt-get install -f

  3. Enter y (Yes) to all prompts.
  4. The content will be installed to the following path: /rsi
  5. Installation is complete.

2. Serial Number Retrieval

Get your RMP license serial number using the downloaded rsiconfig app.

  1. Insert the YubiKey RSI provided for you.
  2. Open the Terminal app.
  3. Get the serial number from the rsiconfig app with the following command:
    sudo rsiconfig -check-license

    You should see a similar output: RapidSetupX IO page The license here is 24352586

3. Licensing

Download and install the RMP rsi.lic.

  1. Navigate to the portal at https://portal.roboticsys.com.
  2. Log in with your RSI-authenticated email.
  3. Navigate to the Licenses tab.
  4. Download a license with your serial number from step 2 (Serial Number Retrieval).
  5. Rename the license to rsi.lic.
  6. Place the rsi.lic in the /rsi folder. (You might have to use sudo copy command)


The RMP Motion Controller should be installed and licensed.


5️⃣ System Configuration

These steps are optional, but recommended.

1. Sleep & Screen-lock Disabling

  1. Open the Terminal app.
  2. Disable sleep with the following command:

    ## Disable screen lock
    sudo systemctl mask sleep.target suspend.target hibernate.target hybrid-sleep.target
    ## Disable desktop screen lock
    gsettings set org.gnome.desktop.screensaver lock-enabled false
    ## Set desktop screen blank time to never
    gsettings set org.gnome.desktop.session idle-delay 0

2. CPU Isolation

We recommend isolating a CPU to dedicate it to the RMP fully. We recommend isolating the last CPU.

  1. Navigate to path: /etc/default/
  2. Open the file: grub
  3. Append parameter isolcpus=YOUR_LAST_CPU_ZERO_INDEX to the line that starts with GRUB_CMDLINE_LINUX_DEFAULT
    • Enter parameters inside the double quotes
    • Leave a space after each new parameter
    • Don’t add space on either side of = or other punctuation.
  4. Save and close the editor.
  5. Open the Terminal app.
  6. Update GRUB with its new configuration and reboot using the following command:

    ## Update GRUB
    sudo update-grub
    ## Reboot the system to apply changes
    sleep 5
    sudo reboot

Note: you can use Ubuntu’s System Monitor app to observe the isolated CPU usage. It should be minimal compared to the rest. Or use the following command to check CPU isolation: sudo dmesg | grep isolcpus

To learn more follow Ubuntu’s guide: Configure GRUB permanently


Your system should have the recommended configurations.