Skip to content

Commit

Permalink
Add documentation for semantic_map_to_2d.
Browse files Browse the repository at this point in the history
  • Loading branch information
cburbridge committed Feb 5, 2016
1 parent 9eed985 commit 8138971
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions semantic_map_to_2d/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
This package contains a single map server node that publishes a downprojected metric map.
A service is provided for chaning which waypoint is currently being published.

# Usage

Start it with

`rosrun semantic_map_to_2d semantic_map_2d_server`

This then provides the service `/set_waypoint` with the following format [TODO: This should be moved to the nodes namespace...]

Request:
- `string waypoint` : The name of the waypoint to switch the map to.

Response:
- `bool is_ok` : If the map was switched or not
- `string response` : Some textual description of what when wrong if not ok.

The map server publishes the map as a `nav_msgs::OccupancyGrid` on the topic `/waypoint_map`.

0 comments on commit 8138971

Please sign in to comment.