<<<<<<< HEAD

Swarmathon-ROS

This repository is a ROS (Robot Operating System) controller framework for the Swarmie robots used in the NASA Swarmathon, a national swarm robotics competition. This particular framework is a ROS implementation of the CPFA (central-place foraging algorithm) developed for iAnt robot swarms at the University of New Mexico.

This repository contains:

Source code for ROS libraries (i.e. packages) that control different aspects of the Swarmie robot, including localization, mapping, mobility, and obstacle and target detection
3D .STL models for the physical Swarmie build
Bash shell scripts for initializing simulated Swarmies in the Gazebo simulator, as well as physical Swarmies

Please submit bug reports for Swarmathon-ROS through GitHub's Issues system. For all other questions regarding the Swarmathon-ROS code base, please visit the forums on the NASA Swarmathon website.
Please consult the git scm and git best practices for guidelines on the most effective approaches to maintaining code. Teams will be expected to commit new code at least every two weeks, and ideally commit one or more times per week. Consult the NASA Swarmathon Timeline for specifics on how often code should be committed, as well as the cutoff date for final code revision before the competition.

Quick Start Installation Guide

Swarmathon-ROS is designed and tested exclusively on the 64 bit version of Ubuntu 14.04 LTS (Trusty Tahr) and ROS Indigo Igloo. This framework may compile and run correctly under other versions of Ubuntu and ROS, but NOTE that these other systems are untested and are therefore not supported at this time.

1. Install ROS Indigo

Follow the detailed instructions for installing ROS Indigo under Ubuntu 14.04 here. We recommend the Desktop-Full installation, which includes the Gazebo 2 simulator.

2. Install additional ROS plugins

Our simulated and physical Swarmies use existing ROS plugins, external to this repo, to facilitate non-linear state estimation through sensor fusion and frame transforms. These plugins are contained in the robot_localization package, which should be installed using the apt-get package management tool:

sudo apt-get install ros-indigo-robot-localization

3. Install additional Gazebo plugins

Our simulated Swarmies use existing Gazebo plugins, external to this repo, to replicate sonar, IMU, and GPS sensors. These plugins are contained in the hector_gazebo_plugins package, which should be installed using the apt-get package management tool:

sudo apt-get install ros-indigo-hector-gazebo-plugins

Our Swarmies can receive mobility commands from the right thumb stick on a Microsoft Xbox 360 controller. The ROS joystick_drivers package, which contains a generic Linux joystick driver compatible with this controller, should also be installed using the apt-get tool:

 sudo apt-get install ros-indigo-joystick-drivers

Joystick commands can also be simulated using the direction keys (Up=I, Down=K, Left=J, Right=L) on the keyboard. The Rover GUI window must have focus for keyboard control to work.

4. Install git (if git is already installed, skip to step 5):

sudo apt-get install git

5. Install Swarmathon-ROS

Clone this GitHub repository to your home directory (~):

cd ~
git clone https://github.com/BCLab-UNM/Swarmathon-ROS.git

Rename the downloaded repo so it can be properly identified by ROS and catkin:

mv ~/Swarmathon-ROS ~/rover_workspace

Change your current working directory to the root directory of the downloaded repo:

cd ~/rover_workspace

Set up ublox GPS submodule:

git submodule init
git submodule update

Compile Swarmathon-ROS as a ROS catkin workspace:

Make sure bash is aware of the location of the ROS environment:

if ! grep -q "source /opt/ros/indigo/setup.bash" ~/.bashrc
then 
  echo "source /opt/ros/indigo/setup.bash" >> ~/.bashrc
fi
source ~/.bashrc

Run catkin_make to build the Swarmathon code:

catkin_make

Update your bash session to automatically source the setup file for Swarmathon-ROS:

echo "source ~/rover_workspace/devel/setup.bash" >> ~/.bashrc
source ~/.bashrc

Update your bash session to automatically export the enviromental variable that stores the location of Gazebo's model files:

echo "export GAZEBO_MODEL_PATH=~/rover_workspace/simulation/models" >> ~/.bashrc
echo "export GAZEBO_PLUGIN_PATH=${GAZEBO_PLUGIN_PATH}:~/rover_workspace/devel/lib/" >> ~/.bashrc
source ~/.bashrc

6. Run the Swarmathon-ROS simulation:

Change the permissions on the simulation run script to make it exectuatable:

cd ~/rover_workspace
chmod +x ./run.sh

Start the simulation

./run.sh

The GUI will now launch. The run script kills a number of gazebo and ROS processes. Killing these processes is suggested by gazebosim.com as the best way to clean up the gazebo environment at the moment.

This is the first screen of the GUI:

Click the "Simulation Control" tab:

Choose the ground texture, whether this is a preliminary or final round (3 or 6 robots), and the distribution of targets.

Click the "Build Simulation" button when ready.

The gazebo physics simulator will open.

Click back to the Swarmathon GUI and select the "Sensor Display" tab.

Any active rovers, simulated or real will be displayed in the rover list on the left side.

Select a rover to view its sensor outputs.

There are four sensor display frames:

The camera output. This is a rover eye's view of the world.

The ultrasound output is shown as three white rays, one for each ultrasound. The length of the rays indicates the distance to any objects in front of the ultrasound. The distance in meters is displayed in text below these rays. The maximum distance reported by the ultrasounds is 3 meters.

The IMU sensor display consists of a cube where the red face is the bottom of the rover, the blue face is the top of the rover, and the red and blue bars are the front and back of the rover. The cube is viewed from the top down. The cube is positioned according to the IMU orientation data. For example, if the rover flips over, the red side will be closest to the observer. Accelerometer data is shown as a 3D vector projected into 2D space pointing towards the sum of the accelerations in 3D space.

The map view shows the path taken by the currently selected rover. Green is the encoder position data. In simulation, the encoder position data comes from the odometry topic being published by Gazebo's skid steer controller plugin. In the real robots, it is the encoder output. GPS points are shown as red dots. The EKF is the output of an extended Kalman filter which fuses data from the IMU, GPS, and encoder sensors.

Click on the "Task Status" tab.

This tab displays the number of targets detected, the number of targets collected, and the number of obstacle avoidance calls.

To close the simulation and the GUI, click the red exit button in the top left-hand corner.

Software Documentation

Source code for Swarmathon-ROS can be found in the ~/rover_workspace/src directory. This diretory contains severals subdirectories, each of which contain a single ROS package. Here we present a high-level description of each package.

abridge: A serial interface between Swarmathon-ROS and the A-Star 32U4 microcontroller onboard the physical robot. In the Swarmathon-ROS simulation, abridge functionality is supplanted by gazebo_ros_skid_steer_drive (motor and encoders) and hector_gazebo_plugins (sonar and IMU; see step 3 of the Quick Start guide).
mobility: The top-level controller class for the physical and simulated robots. This package receives messages on the status of targets and/or obstacles in front of the robot and autonomously makes decisions based on these factors. This packages also receives pose updates from robot_localization (see step 2 of the Quick Start guide) and commands from joystick_drivers (see step 3 of the Quick Start guide).
obstacle_detection: A logic processor that converts sonar signals into a ternary collision value. This package receives sonar messages from abridge (for physical robots) or hector_gazebo_ros_sonar (for simulated robots), and returns a status message to differentiate between three possible cases:
1. No collision
2. A collision on the right side of the robot
3. A collision in front or on the left side of the robot
rqt_rover_gui: A Qt-based graphical interface for the physical and simulated robots. See How to use Qt Creator for details on this package.
target_detection: An image processor that detects AprilTag fiducial markers in the onboard camera's video stream. This package receives images from the usbCamera class (for physical robots) or gazebo_ros_camera (for simulated robots), and, if an AprilTag is detected in the image, returns the integer value encoded in the tag.
ublox: A serial interface to the ublox GPS receiver onboard the physical robot. This package is installed as a git submodule in the Swarmathon-ROS repo. See the ublox ROS wiki page for more information.

How to use Qt Creator to edit the simulation GUI

Install Qt Creator:

sudo apt-get install qtcreator
sudo apt-get install python-catkin-tools

Build the workspace:

catkin clean -a
catkin build

Run Qt Creator:

qtcreator &

Choose "Open File or Project" from the File menu
Navigate to ~/rover_workspace/src/rqt_rover_gui/
Select CMakeLists.txt
Click "Open" to continue.
Enter path to your home directory /rover_workspace/build in the text box, this is the default build path. You cannot use the ~ as a shorthand to your home directory here.
Click Configure Project
Click on the Projects icon on the left toolbar
Enter -DCMAKE_INSTALL_PREFIX=../install -DCATKIN_DEVEL_PREFIX=../devel in the CMake arguments text box
Click the "Edit" toolbox icon on the left
Double-click CMakeLists.txt
Click the "Build Now" button to build the project

Qt Creator can now be used to build the rover_workspace

Note: start qtcreator in your terminal with rover_workspace as the current directory. Source the ~/.bashrc if the catkin environment variables are not set so that QT Creator can properly build the project.

Debugging with GDB and Qt Creator

Debuggers are particularly useful for tracking down segfaults and for tracing through the logic of your programs. In order to use the GNU debugger (GDB) with the swarmathon competition add the following line to the CMakelists.txt file for the project you want to debug.

set(CMAKE_BUILD_TYPE Debug)

This will compile your code with debugging symbols enabled.

Since ROS is multithreaded you may need to attach the debugger to threads that have been spawned by your program. To enable this enter the following in a terminal:

sudo apt-get install libcap2-bin

sudo setcap cap_sys_ptrace=eip /usr/bin/gdb

To use QT Creator to debug your already running program click the "Debug" menu. Choose "Start Debugging" and then "Attach to Running Application...". You will be able to use the graphical interface to GDB from here.

Swarmathon2016

Summer research code

18c40c5653ba334e1908f7f436d62cbb7903ba25

RoboticSwarmControl/Swarmathon2016SLAM