Backing up your robot’s data¶
It is always a good idea to keep any customized configuration files or project source code backed up. This is especially true when upgrading your robot from ROS Kinetic to Melodic, as this process will wipe the robot’s internal storage.
Clearpath provides a simple shell script you can use to create a backup of most of your robot’s important data. You can download a copy of this script by running the following command on your computer:
git clone https://github.com/clearpathrobotics/robot-backup
Follow the instructions in the
robot-backup/README.md file to ensure you have all of the prerequisites installed.
Running the backup¶
Ensure that the robot is turned on and that you can SSH into it from your computer. Then run the following from your computer:
cd robot-backup bash backup.sh <backup-name> <hostname|IP address of the robot>
For example, if your robot’s IP address is 192.168.1.103, you would run something like
bash backup.sh kinetic-final-backup 192.168.1.103
This will produce a backup file called
kinetic-final-backup.tar.gz. Keep this file for when you need to
restore your backed-up data.
By default all Clearpath robots use the username “administrator” and the password “clearpath”. The
will use these credentials by default, but you can override them easily.
For example, if your robot has been modified to use an Nvidia Jetston TX2, the username and password will both be “nvidia”. In this case, you should run
bash backup.sh kinetic-final-backup email@example.com nvidia
What gets backed up¶
The backup script will copy the following data:
the contents of the user’s home folder:
specified user’s groups
manually-installed apt packages
Backing up non-standard installations¶
backup.sh script assumes that your robot is in a roughly-standard configuration; it uses a single user account
and no files within
/opt/ros/kinetic have been modified.
If this is not the case, it is the responsibility of the user to ensure that any modified files and files in other users’ home folders is backed up correctly.
A common example of this might be if you have created customized URDF files to be loaded via environment variables
JACKAL_URDF_EXTRAS) and have stored them outside any of the folders specified above, you must back these
backup.sh will not do this for you.