rosparam_handler

Package Summary

A unified parameter handler for nodes with automatic code generation. Save time on defining your parameters. No more redundant code. Easy error checking. Make them dynamic with a single flag.

• Maintainer status: maintained
• Maintainer: Jeremie Deray jeremie.deray@pal-robotics.com
• Author: Claudio Bandera cbandera@posteo.de
• License: BSD
• Bug / feature tracker: https://github.com/cbandera/rosparam_handler/issues
• Source: git https://github.com/cbandera/rosparam_handler.git (branch: master)

Unified Parameter Handling for ROS

When working with ROS and Parameters, there are a couple of tools to help you with handing Parameters to your nodes and to modify them, e.g. Parameter Server and dynamic_reconfigure.

But with the multitude of options on where to specify your parameters, we often face the problem that we get a redundancy in our code and config files.

The rosparam_handler let’s you:

• specify all of your parameters in a single file.
• use a generated struct to hold your parameters.
• use member method for grabbing the parameters from the parameter server.
• use member method for updating them from dynamic_reconfigure.
• make your parameters configurable with a single flag.
• set default, min and max values.
• choose between global and private namespace.
• save a lot of time on specifying your parameters in several places.
• …in both C++ and Python !

Usage

See the Tutorials on

• How to write your first .params file
• How to use your parameter struct
• rosparam_handler_tutorial

Installation

rosparam_handler has been released in version 0.1.3 for

• indigo
• jade (EOL - version 0.1.1)
• kinetic
• lunar

To get the package run rosdep update && rosdep install rosparam_handler

Contribution

rosparam_handler is developed according to Vincent Driessen’s Gitflow Workflow. This means,

• the master branch is for releases only.
• development is done on feature branches.
• finished features are integrated via PullRequests into develop.

For a PullRequest to get merged into develop, it must pass

• Review by one of the maintainers.
  • Are the changes introduces in scope of the rosparam_handler?
  • Is the documentation updated?
  • Are enough reasonable tests added?
  • Will these changes break the API?
  • Do the new changes follow the current style of naming?
• Compile / Test / Run on all target environments.

Credits

This project uses Open Source components. The code was, in large parts, built upon such existing open source software. You can find the source code of their projects along with license information below. We acknowledge and are grateful to these developers for their contributions to open source.

Project: dynamic_reconfigure Copyright 2015, Open Source Robotics Foundation, Inc. License: 3-Clause BSD

Changelog for package rosparam_handler

0.1.4 (2018-09-02)

• update doc
• fix #57 replace map/vec custom stream op by func
• update readme
• add toConfig
• Fix #47 Do not print error message while retrieving param with default value.
• Contributors: Jeremie Deray, artivis

0.1.3 (2018-03-23)

• Merge pull request #50 from cbandera/develop Use industrial_ci & docker
• Merge pull request #45 from cbandera/feature/travis_industrial_ci Change travis conf to use industrial_ci & docker
• Merge pull request #48 from cbandera/develop Fix install rule
• Merge branch 'develop' into feature/travis_industrial_ci
• Merge pull request #46 from plusone-robotics/plusone/master Fix CI Breaking on External Projects
• Merge pull request #3 from geoffreychiou/gc_fix_ci Fixed CI Build Error Caused by rosparam_handler
• added slash at end of include dir
• Merge branch 'develop' into feature/travis_industrial_ci
• change travis conf to use industrial_ci & docker
  • using industrial_ci simplifies a lot the travis conf file
  • using Docker enables CI for kinetic & lunar
• Contributors: Claudio Bandera, Geoffrey Chiou, Jeremie Deray, geoffreychiou

0.1.2 (2018-02-07)

Release 0.1.2 fix #34. Append local path at the beginning of PYTHON_PATH Update maintainer Add test dynamic_reconfigure

• std::endl -> n YamlGenerator closes #30
• Bugfixes
• Uncomment lines without default, to force user to set them
• Added documentation for generator script
• Reformatted python files
• ClangFormat files
• Simplified utility functions
• Fix for failing tests
• Added functionality for setting parameters on server.
• Added documentation to functions
• Moved common function to util header
• Removed debugging leftover Add Python support
• Display correct test names for each test
• Replaced errors with warnings For python, when min/max is corrected. The behaviour is now similar to cpp
• Made tests visible Replaced individual testcases with TestSuite
• Set default values on param server, add python tests for that
• Remove useless comment leftovers Bugfix/force clean builds
• Readded check for C++11 support.
• Force travis to do a clean build
• Removed verbose output during build Fix initialisation order in parameter class template
• Fixed merge error in template Remove useless character Set default values on parameter server if no value is set
• Updated the documentation
• Remove duplicate test
• Add unittests
• Name tests properly, add cmake dependency
• Throw more informative exception if parameters without default value are unset
• Add python unittests Feature/add continous integration
• Changed build flag to display develop branch
• Updated README contribution guide
• Added matrix job and removed C++14 check
• Added initial travis config
• Added first set of tests
• Added LICENSE file. Closes #25
• Updated README to include release information. Closes #17.
• Moved common functions to utilities.hpp. Fixes #11
• Handler is now throwing an exception upon failure. Before, it was calling std::exit(EXIT_FAILURE) but it was causing problems during testing.
• Add min/max check for map and vector to be consistent with C++
• Include python usage in documentation
• Set default values on parameter server if no value is set
• Fix initialisation order in parameter class template
• param handler now generates python parameter files too
• Remove useless character
• Contributors: Claudio Bandera, Fabian Poggenhans, Jan-Hendrik Pauls, Jeremie Deray, Niels Ole Salscheider, vincentrou

0.1.1 (2017-05-31)

• Initial release of rosparam_handler
• Contributors: Claudio Bandera, Fabian Poggenhans, Jeremie Deray, Matthias Füller, Nikolaus Demmel, Sascha Wirges, artivis