Skip to content

RoboJackets/urc-software

Repository files navigation

urc-software CI Status Badge

Welcome to the RoboJackets URC software repo! This document will give you a brief description of the repo's layout and an overview of the repo.

Software Lead

Folder Structure

  • urc_analysis

  • urc_gazebo Helper nodes used for simulation purposes

  • urc_manipulation

  • urc_msgs Custom ROS messages used in the various ROS packages

  • urc_navigation Collection of nodes that form our navigation stack

  • urc_perception Collection of nodes that form our perception stack

  • urc_platform Nodes that are platform specific and used to communicate with the hardware, ie. IMU, joystick and motor controller

  • urc_util A collection of utility nodes and classes

  • documents Research and design documents.

Installation Guide

1. Install ROS2

sudo apt install software-properties-common
sudo add-apt-repository universe
sudo apt update && sudo apt install curl gnupg lsb-release
sudo curl -sSL https://raw.githubusercontent.com/ros/rosdistro/master/ros.key -o /usr/share/keyrings/ros-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ros-archive-keyring.gpg] http:https://packages.ros.org/ros2/ubuntu $(source /etc/os-release && echo $UBUNTU_CODENAME) main" | sudo tee /etc/apt/sources.list.d/ros2.list > /dev/null
sudo apt update
sudo apt install ros-galactic-desktop

2. Install Colcon

sudo apt install python3-colcon-common-extensions

3. bashrc Setup

echo "source /opt/ros/galactic/setup.bash" >> ~/.bashrc
echo "source /usr/share/colcon_argcomplete/hook/colcon-argcomplete.bash" >> ~/.bashrc
source ~/.bashrc

4. Create a colcon environment

cd <path to where you want to keep the project>
mkdir -p colcon-urc/src

5. Clone the repository into the colcon environment

cd colcon-urc/src
git clone https://github.com/RoboJackets/urc-software.git --recursive

6. Build your workspace

cd ..
colcon build --symlink-install

7. Source your environment

. install/setup.bash

Contributing

Join our slack here!