Skip to content

CabrilloRoboticsClub/robosub_ros

Repository files navigation

RoboSub ROS

This document has instructions to get you started. Reach each section carefully.

Setup (All Platforms)

If you have a Windows, Mac or Linux on your desktop you can use Docker and Development Containers in vscode to do local development. This is the fastest and easiest way to get setup and enables you to run the simulator and control the ROV on your computer. This is the recommended setup for everyone.

  1. Install vscode

  2. Install Docker Desktop

    • Docker command line is sufficient on Linux
  3. Follow the Dev Containers Tutorial

  4. Follow the linked instructions on how to clone a repository locally, login to GitHub and when prompted, put in the repository URL:

    https://github.com/CabrilloRoboticsClub/robosub_ros.git    
    
  5. You will be prompted to re-open the folder in a development container. Select yes. Confirm that you have the devconainer open by looking at the bottom left corner of VScode. It should look like the picture below:

  6. Create a Terminal in your vscode window with the Terminal -> New Terminal menu.

Quick Start

Here are some steps to test your repository. These steps work on my setup at home. The simulation stack is very heavy and may require a reasonably powerful GPU. Run this command in the dev container terminal.

  1. Build the software in your dev container:

    make
    
  2. Source the setup.bash file after the build is complete.

    source install/setup.bash
    
  3. Launch a simulation:

    ros2 launch ardupilot_gz_bringup iris_runway.launch.py
    
  4. Control the simulation with a flight controller. There are a number of programs available. I have had success with QGroundControl.

Tutorials

Ardupilot has official tutorials here:

None of the tutorial's setup steps are necessary. The development container is fully setup.