Overview

This procedure describes the best practice of updating the RapidPlan and RapidSense software. The following update process does not require internet access on the Realtime Controller.

IMPORTANT: the update procedure requires a currently-installed RapidPlan software version of 1.2.0 or higher, on a Realtime Controller. Please contact Realtime Robotics Support at realtimesupport@rtr.ai, if the software or hardware differs from the requirements listed.

Requirements

• RapidPlan version 1.2 or higher

• Realtime Controller Hardware

Peripheral Equipment

To perform this procedure, the following items need to be connected to the controller:

• Keyboard

• Mouse

• Monitor

• External storage device

Create a Backup File

Backup the project files as described in the Back-Up and Restore Procedure document. Note that the updating process will not delete the project files.

Downloading Software Version Installer

Software Suite Installer

When updating the software, the first step is to download the software update files from files.rtr.ai. There are two files required to update the software:

1. rapidplan_{SOFTWARE_VERSION_ID}.deb.run

2. rapidplan_{SOFTWARE_VERSION_ID}.deb.run.check.asc

If the RTR Controller has access to the internet, download the files and move both of them to the ~/Documents folder. Otherwise, download them on another computer and transfer them to the ~/Documents folder in the Realtime Controller using an external storage device.

Robot Models Installer

Realtime Robotics has a software package for each robot OEM. You will be provided with the files for whichever OEMs you work with. There are two base files required and then two files required for each OEM :

The base install files are:

• rtr-robot-models_{SOFTWARE_VERSION_ID}_amd64.deb.run

• rtr-robot-models_{SOFTWARE_VERSION_ID}_amd64.deb.run.check.asc

For each robot OEM, you will get:

• rtr-robot-models-{OEM}_{SOFTWARE_VERSION_ID}_amd64.deb.run

• rtr-robot-models-{OEM}_{SOFTWARE_VERSION_ID}_amd64.deb.run.check.asc

If the RTR Controller has access to the internet, download the files and move both of them to the ~/Documents folder. Otherwise, download them on another computer and transfer them to the ~/Documents folder in the Realtime Controller using an external storage device.

Updating the software

Opening a Terminal

The software upgrade and installation procedure is run from a terminal on the Realtime Controller. Use the following steps to open a terminal.

1. Open a terminal window using one of the following methods:

   1. From the favorites bar:

      1. Select the Terminal Icon from the favorites bar:

         

   2. From an applications search:

      1. Select the icon to show applications, from the bottom left corner of the screen:

         

      2. In the search bar, type “Terminal” and select the Terminal icon:

         

Realtime Robotics Software Upgrade

1. Follow the steps above to open a terminal

2. Enter the following command in the terminal to change the directory to the Documents folder, which contains the update files:

   $ cd ~/Documents

   

3. Enter the command below in the terminal to make the *.deb.run file executable:
   (Hint: Use the Tab key to auto-complete the filename to avoid typos. Type the command and the first part of the filename and then press Tab to auto-complete. If there are multiple files in the directory that share the initial part of the filename, Tab will auto-complete until there’s a difference in the filenames. Enter the next letter and press Tab again to continue.)

   $ chmod +x rapidplan_{SOFTWARE_VERSION_ID}.deb.run

   

4. Enter the following command in the terminal to begin the update:

   $ sudo rtr-sigexec rapidplan_{SOFTWARE_VERSION_ID}.deb.run

   1. Upon running the command, a prompt requiring the RTR-User password will appear in the terminal window. Note: the text you enter will not be displayed as you type.

   2. Enter the RTR-User password (“Realtime123”) and press Enter to continue the update.

   

5. A successful upgrade will finish with the line:

   INFO: Success! The user initiated software installation has completed successfully.

   

6. After a successful installation, restart the Controller to complete the upgrade process.

Robot Model Package Installation

1. Follow the steps above to open a terminal

2. Enter the following command in the terminal to change the directory to the Documents folder, which contains the update files:

   $ cd ~/Documents

   

3. Enter the following commands in the terminal to make each robot models file executable:

   $ chmod +x rtr-robot-models*

   

4. Enter the command below in the terminal to begin installing/updating the base robot models package:

   (Hint: Use the Tab key to auto-complete the filename to avoid typos. Type the command and the first part of the filename and then press Tab to auto-complete. If there are multiple files in the directory that share the initial part of the filename, Tab will auto-complete until there’s a difference in the filenames. Enter the next letter and press Tab again to continue.)

   $ sudo rtr-sigexec rtr-robot-models_{SOFTWARE_VERSION_ID}_amd64.deb.run

   

   1. Upon running the command, a prompt requiring the RTR-User password will appear in the terminal window.

   2. Enter the RTR-User password (“Realtime123”) and press Enter to continue the update.

5. A successful upgrade will finish with the line:

   INFO: Success! The user initiated software installation has completed successfully.

   

6. For every robot OEM package you have, enter the following command in the terminal to begin installing/updating the robot models package:

   $ sudo rtr-sigexec rtr-robot-models-{OEM}_{SOFTWARE_VERSION_ID}_amd64.deb.run

   

7. A successful upgrade will finish with the line:

   INFO: Success! The user initiated software installation has completed successfully.

Contacting Support

Please contact Realtime Robotics support team at realtimesupport@rtr.ai if you encounter any problems following this procedure.