aditya-vk / robowflex

Making MoveIt Easy!

Robowflex 💪🤖

Making MoveIt Easy. Documentation for this project can be read online at GitHub pages.

What is Robowflex?

Robowflex is primarily a wrapper around components from other robotics libraries (in particular, components from MoveIt). The name "Robowflex" is a portmanteau of "Robot" and "Bowflex", as Robowflex was intended just to be better "bench"-marking software (as in "bench press") than the rest. However, the software needed for doing benchmarking was the same as the software needed for running motion planning in "isolation" from a ROS system while still using ROS components, useful for many other things other than benchmarking. Thus, the project has spun out and become a toolbox for motion planning using real robots that are MoveIt enabled.

The high-level goals of the project are as follows:

• Provide an easy to use interface to complex robotics libraries by brushing cruft and idiosyncrasies under the rug.
• Provide access to all underlying capabilities of the libraries so users are not hampered by Robowflex in any way.
• Remain untied as possible to the greater ROS system, and support all distros from Indigo onward.

Build Status

Workflow	Status
Documentation
Linting
Indigo
Kinetic
Melodic
Noetic

robowflex_library

A library that simplifies using MoveIt in applications. Examples of basic motion planning, benchmarking of planning requests, and input/output can be found in the robowflex_library/scripts directory.

Optional Robowflex Modules

Robowflex also comes with many optional modules that provide specific auxiliary library support through the standard Robowflex interface. The modules are only compiled if the required dependencies are installed.

robowflex_visualization

Python scripts for visualizing robots and motion plans in Blender. See robowflex_visualization/README.md for more information on how to use.

robowflex_ompl

An optionally compiled library component that adds more direct access to OMPL through a new robowflex::Planner. Requires moveit_planners_ompl, from MoveIt. Some basic examples of how to use the new planner are in robowflex_ompl/scripts.

robowflex_tesseract

An optionally compiled library component that adds support for tesseract-based planners. Requires both tesseract and trajopt. Some basic examples of how to use the new planner(s) are in robowflex_tesseract/scripts.

robowflex_movegroup

A library component with helper classes and functions to interact with a move_group process being used for motion planning. Scenes can be pushed and pulled and trajectories can be executed with this component through move_group.

robowflex_dart

A optionally compiled library that adds support for modeling and planning through DART (Dynamic Animation and Robotics Toolkit). There are features for loading robots just through DART or by converting _MoveIt robots into the DART representation. Motion planning is supported through OMPL. This module offers easy multi-robot motion planning through composing complex worlds with multiple robots. Additionally, this module has manifold-constrained motion planning with a Task Space Region constraint specification.

robowflex_resources

robowflex_resources is a separate repository that contains the MoveIt configuration and kinematic description for robots used in example scripts.

Installation Instructions

Robowflex is supported on many ROS platforms, from Indigo on Ubuntu 14.04 to Melodic on 18.04. Here are some bare-bones installation instructions to get up and running on a new Ubuntu 18.04 machine without ROS already installed. This will only enable the core modules to be built, as some modules require special packages to be installed.

First, install ROS following the directions copied below:

sudo sh -c 'echo "deb http://packages.ros.org/ros/ubuntu $(lsb_release -sc) main" > /etc/apt/sources.list.d/ros-latest.list'
sudo apt-key adv --keyserver 'hkp://keyserver.ubuntu.com:80' --recv-key C1CF6E31E6BADE8868B172B4F42ED6FBAB17C654
sudo apt update
sudo apt install ros-melodic-desktop-full
sudo rosdep init
rosdep update
source /opt/ros/melodic/setup.bash
sudo apt install python-rosinstall python-rosinstall-generator python-wstool build-essential

We recommend catkin-tools to build your ROS workspace:

sudo apt install python-catkin-tools

Install MoveIt and other required ROS packages:

sudo apt install ros-melodic-moveit ros-melodic-geometry

Finally, create a workspace with Robowflex inside:

cd ~
mkdir -p rb_ws/src
cd rb_ws
source /opt/ros/melodic/setup.bash # if you haven't already
catkin config --init
cd src
git clone https://github.com/KavrakiLab/robowflex.git
catkin build

To try out a demo script, you first need a robot description. The easiest to try is the Fetch robot, either by debian or source:

# Debian
sudo apt install ros-melodic-fetch-ros

# Or, Source
cd ~/rb_ws/src
git clone https://github.com/fetchrobotics/fetch_ros
catkin build

After the workspace is built, source and run a demo:

cd ~/rb_ws
source ./devel/setup.bash
rosrun robowflex_library fetch_test

Code Formatting

All C++ code should be formatted with clang-format. Use the format.sh script to automatically format the code base.