Skip to content

Commit

Permalink
Merge pull request ros-industrial-attic#27 from LorenzBung/improve-do…
Browse files Browse the repository at this point in the history
…cumentation

Improve documentation
  • Loading branch information
schornakj authored Apr 21, 2020
2 parents ee87867 + a836fb2 commit 4df1776
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,26 @@ After re-sourcing the workspace, start the demo from the provided launch file:
```
roslaunch yak_ros demo.launch
```


## Usage

The yak_ros node provides 3 services and is a subscriber to 2 topics, which can be used to interact with it.


#### Topics

1. `/yak_ros/input_depth_image`: Listener for published depth images.
2. `/yak_ros/input_point_cloud`: Listener for published point clouds.


#### Services

1. `/yak_ros/generate_mesh`: Used to generate the output mesh to the provided path.
2. `/yak_ros/reset_tsdf`: Resets the TSDF Volume (= delete all provided depth images / point clouds)
3. `/yak_ros/update_params`: Used to update the TSDF Volume Params.


#### Visualization

A bounding box around the area of the TSDF Volume is published under the `/tsdf_node/visualization_marker` marker and can be viewed in `rviz`.

0 comments on commit 4df1776

Please sign in to comment.