A parser for SMURF files, yielding a URDF model and the additional SMURF data using ConfigMaps.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images
scripts/cmake
src
CMakeLists.txt
COPYING
COPYING.LESSER
README.md
manifest.xml
smurf_parser.pc.in

README.md

SMURF Parser

When reading in a SMURF robot representation, the SMURF parser yields a boost::shared_ptr to a URDF model as well as a ConfigMap containing the annotations contained in the SMURF's YAML files (see below).


SMURF

What is SMURF?

SMURF stands for Supplementable, Mostly Universal Robot Format and is an attempt to overcome the limitations of URDF (and SRDF) to create a more versatile format that can be easily adapted to the needs of different groups of users and projects.

Structure

SMURF is not so much a format for a single file but rather defines a hierarchy of files that together provide information on different aspects of a robot. Thus a SMURF robot definition consists of one main .smurf file containing general data on the model and a list of files that should be included in the SMURF representation of the robot. At a minimum, a .urdf file that defines the robot’s kinematics is listed here. Normally, the list will also contain other files - encoded in the YAML format - defining different parts of the robots such as sensors, motors or additional data, e.g. simulation parameters.

Example SMURF for the Mantis robot Example SMURF representation of the Mantis robot (some names blurred to not promote particular hardware)

In these YAML files, information can be linked to specific parts of the robot by referencing them by type and name as specified in the URDF (combinations of type/name are unique in URDF). For instance, a sensor can be defined by attaching it to a link, then specifying its update rate and other parameters. Similarly, motors can be attached to joints, specifying maximum torques and turning speeds. This information does not have to be provided redundantly, as it is possible to define URIs of additional YAML files containing the data which is not explicitly listed in an entry. This makes it possible to maintain a central database of devices used multiple times in the same robot or even in different robots, without the need to update every single model independently if any single part changes and thus reducing repetitive workload and errors.

Extensibility

Apart from a core set of defined features such as the ones listed above, SMURF provides the user with the freedom of specifying any kind of information related to any part of the robot or the model as a whole, using a subset of the YAML syntax. The existing C++ SMURF parser recursively traverses the entire SMURF file tree and provides all the data of the model in an easy-to-work-with data format called a ConfigMap, which is a C++ implementation of a Python dictionary using templates. The parser was originally part of the MARS simulation, but has since been turned into a separate library.

Compatibility & Editing

SMURF is compatible with the MARS simulation and will be compatible with future versions of the Rock robotics framework. URDFs contained in SMURF do not have any custom tags and are thus compatible with the ROS robotics framework and the Gazebo simulation. Phobos is a plugin for the free 3D modelling software Blender, turning the latter into a powerful tool for creating and editing SMURF robot models. It is itself open source software, distributed under the LPGL license, and is hosted on GitHub.