This is a template: replace, remove, and add where required. Describe here what this package does and what it's meant for in a few sentences.
Keywords: example, package, template
The source code is released under a BSD 3-Clause license.
Author: Péter Fankhauser
Affiliation: ANYbotics
Maintainer: Péter Fankhauser, [email protected]
The PACKAGE NAME package has been tested under ROS Indigo and Ubuntu 14.04. This is research code, expect that it changes often and any fitness for a particular purpose is disclaimed.
If you use this work in an academic context, please cite the following publication(s):
-
P. Fankhauser, M. Bloesch, C. Gehring, M. Hutter, and R. Siegwart: PAPER TITLE. IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2015. (PDF)
@inproceedings{Fankhauser2015, author = {Fankhauser, P\'{e}ter and Hutter, Marco}, booktitle = {IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)}, title = {{PAPER TITLE}}, publisher = {IEEE}, year = {2015} }
To install all packages from the this repository as Debian packages use
sudo apt-get install ros-indigo-...
- Robot Operating System (ROS) (middleware for robotics),
- Eigen (linear algebra library)
To build from source, clone the latest version from this repository into your catkin workspace and compile the package using
cd catkin_workspace/src
git clone https://github.com/ethz-asl/ros_package_template.git
cd ../
rosdep install --from-paths . --ignore-src
catkin_make
Run the unit tests with
catkin_make run_tests_ros_package_template
Describe the quickest way to run this software, for example:
Run the main node with
roslaunch ros_package_template ros_package_template.launch
Config file folder/set 1
- config_file_1.yaml Shortly explain the content of this config file
Config file folder/set 2
- ...
-
launch_file_1.launch: shortly explain what is launched (e.g standard simulation, simulation with gdb,...)
Argument set 1
argument_1
Short description (e.g. as commented in launch file). Default:default_value
.
Argument set 2
...
-
...
Reads temperature measurements and computed the average.
-
/temperature
(sensor_msgs/Temperature)The temperature measurements from which the average is computed.
...
-
get_average
(std_srvs/Trigger)Returns information about the current average. For example, you can trigger the computation from the console with
rosservice call /ros_package_template/get_average
-
subscriber_topic
(string, default: "/temperature")The name of the input topic.
-
cache_size
(int, default: 200, min: 0, max: 1000)The size of the cache.
...
Please report bugs and request features using the Issue Tracker.