Ros-vehicle Docs

The entire project is documented here including how to get it up and running!

Get started now View it on GitHub


Getting started

Installing ROS

ROS Noetic has been used for this project. Detailed installation instructions can be found in the official ROS Wiki. The following is a summary for installation on ubuntu:

  1. Set up sources

    sudo sh -c 'echo "deb http://packages.ros.org/ros/ubuntu $(lsb_release -sc) main" > /etc/apt/sources.list.d/ros-latest.list'
    
  2. Set up keys

    sudo apt install curl # if you haven't already installed curl
    
    curl -s https://raw.githubusercontent.com/ros/rosdistro/master/ros.asc | sudo apt-key add -
    
  3. Install ROS

    sudo apt update
    
    sudo apt install ros-noetic-ros-base
    
  4. Setting up the environment

    echo "source /opt/ros/noetic/setup.bash" >> ~/.bashrc
    source ~/.bashrc
    
  5. Set up dependancies

    sudo apt-get install python3-rosinstall python3-rosinstall-generator python3-wstool build-essential ros-noetic-roslint
    
  6. Install and initialize rosdep

    sudo apt install python3-rosdep
    sudo rosdep init
    rosdep update
    

Initializing the workspace

A workspace has to be initialized where all the ROS packages are kept.

  1. Make and navigate to the workspace directory
    mkdir -p ~/catkin_ws/src
    cd catkin_ws/src
    
  2. Initialize workspace
    catkin_init_workspace
    
  3. Build the workspace
    cd ~/catkin_ws
    catkin_make
    
  4. Add the workspace path to shell
    echo "source ~/catkin_ws/devel/setup.bash" >> ~/.bashrc
    source ~/.bashrc
    
  5. Clone the repository
      cd ~/catkin_ws/src
      git clone https://github.com/mubarizahmed/ros-vehicle
    
  6. Build the workspace
    cd ~/catkin_ws
    catkin_make
    

Dependencies

The following packages are required additionally:

  1. rosserial_python | Docs
    sudo apt install ros-noetic-rosserial-python
    
  2. teleop_twist_gamepad | Docs
    cd ~/catkin_ws/src
    git clone https://github.com/Reinbert/teleop_twist_gamepad
    cd ..
    catkin_make