Sunflower Mobile Robot Library, version 2 bundled with the Nepumuk planar robot simulator.
C++ Other
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
3rdparty/fpplib
apps
attic
doc
npm
npm2
opt/npmestar
ros fixed compilation on Linux Nov 28, 2014
sfl
.gitignore
CMakeLists.txt
LICENSE.GPLv2
README.md

README.md

Sunflower2 Mobile Robot Library and Nepumuk Simulator

For the Impatient

You need CMake, OpenGL, GLU, and GLUT.

mkdir build
cd build
cmake ..
make
./nepumuk -c ../apps/test0.yaml

Press c for continuous simulation and q to quit.

To create the API docs, you need Doxygen.

cd doc
doxygen Doxyfile

This creates the html/ folder, with an index.html file to start browsing.

ROS support

Is being developed under Hydro, have a look at the ros/ subdirectory. The idea is that you can plop the sfl2 checkout into a catkin workspace, then catkin_make for that worksapce should just pick it up. The basic approach is to use nepumuk plugins that talk ROS, while keeping the core sfl and npm stuff blissfully ignorant of ROS.

----------------------------------------------------------------------------
Copyright (C) 2004, 2005, 2007, Ecole Polytechnique Federale de Lausanne. All rights reserved.
Copyright (C) 2005, LAAS-CNRS. All rights reserved.
Copyright (C) 2006, 2007, ETH Zurich. All rights reserved.
Copyright (C) 2005-2009, 2012, Roland Philippsen. All rights reserved.

Maintainer:   Roland Philippsen
Contributors: Viet Nguyen, Frederic Pont, Sascha Kolski, Agostino
              Martinelli, Kristijan Macek, Marc Hanheide, Johannes
              Wienke, and others

This software is released under the GNU General Public License (GPL),
version 2. See the LICENSE.GPLv2 file for more information.
----------------------------------------------------------------------------

Introduction

Sunflower contains mobile robotic programming abstractions developed mainly at the Autonomous Systems Lab (ASL), EPFL (now at ETH Zurich). It is written in C++ and provides a framework of classes and utilities for common tasks and patterns in mobile robotics. As a concrete application of those abstractions, sunflower contains obstacle avoidance code developed during a PhD thesis at the ASL (see chapter 3).

Compiling

This software has been compiled under Linux, Mac OS X, OpenBSD, and even once or twice under Windows. For a basic setup, you need a C++ compiler (tested with GCC 3 and 4)

In order to build the Nepumuk simulator which comes bundled with Sunflower, you will also need OpenGL, GLU, and GLUT development packages.

We use CMake to provide a cross-platform build setup. It is recommended to build in a separate directory:

$ mkdir build
$ cd build
$ cmake ..
$ make

Running

If you have built the Nepumuk simulator (should happen automatically if you have all required prerequisites), then you can start running the examples, such as

./nepumuk -c ../apps/test0.yaml

In Nepumuk's GL window, press c for continuous mode, SPACE for step-by-step simulation, and q to exit the program. Some more keybindings exist, check the apps/Simulator.cpp code.

Documentation

Sunflower uses Doxygen to provide documentation through comments inside the sourcecode. You can either rely on the fact that the vast majority of these comments is in the class declarations (ie header files), or go into the doc/ subfolder and run Doxygen there. The doxy config assumes you have Graphviz installed, to generate diagrams.

cd doc
doxygen Doxyfile

Open the resulting html/index.html file to start browsing the documentation. It's still somewhat under construction, of course...

Project Layout (somewhat outdated)

  • sfl/util/

    Basic classes and other utilities.

  • sfl/api/

    Mobile robotic abstractions, some with default implementations, others in form of interfaces.

  • sfl/dwa/

    An implementation of the Dynamic Window Approach to obstacle avoidance, modified for differential drive robots and with pre-calculated lookup-tables for very fast execution.

  • sfl/bband/

    An implementation of a radically simplified Elastic Band approach to on-line path modification, aimed at keeping computations very lightweight but sacrifycing accuracy.

  • sfl/gplan/ An early attempt at generalized grid-based path planners, only useful for it's implementation of the NF1 planner. (The E-Star project provides a more powerful approach but has not been integrated with libsunflower yet.)

  • sfl/expo/

    The integrated path planning and obstacle avoidance system used during the Swiss National Exhibition expo.02. For 6 months it controlled 10 Robox tour guide robots at the Robotics pavillion.

  • npm/

    The core classes for the Nepumuk simulator.

  • npm/gfx

    Graphics output of Nepumuk.

  • npm/ext

    Nepumuk's (currently simplistic) extension mechanism.

  • apps/

    Sourcecode for executables.

References

@phdthesis{philippsen:2004:thesis,
  author = {Philippsen, Roland},
  title  = {Motion Planning and Obstacle Avoidance for Mobile Robots
           in Highly Cluttered Dynamic Environments},
  school = {Ecole Polytechnique F\'ed\'erale de Lausanne},
  year   = 2004
}