Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Dashing docs #62

Merged
merged 2 commits into from
Dec 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
[![Build Status](https://travis-ci.org/osrf/ros_ign.svg?branch=master)](https://travis-ci.org/osrf/ros_ign.svg?branch=master)
[![Build Status](https://travis-ci.org/osrf/ros_ign.svg?branch=dashing)](https://travis-ci.org/osrf/ros_ign/branches)

* ROS 1 branches:
* [melodic](https://github.com/osrf/ros_ign/tree/melodic)
* ROS 2 branches:
* [dashing](https://github.com/osrf/ros_ign/tree/dashing)

# Integration between ROS and Ignition

This repository holds packages that provide integration between
[ROS](http://www.ros.org/) and [Ignition](https://ignitionrobotics.org):

* `ros_ign`: Metapackage which provides all the other packages.
* `ros_ign_image`: Transport bridge from Ignition transport to ROS using [image_transport](http://wiki.ros.org/image_transport).
* `ros_ign_bridge`: Transport bridge between ROS and Ignition transport.
* `ros_ign_gazebo_demos`: Demos using the ROS-Ignition integration.
* `ros_ign_point_cloud`: Plugins for publishing ROS point clouds from Ignition Gazebo simulations.

* [ros_ign](https://github.com/osrf/ros_ign/tree/dashing/ros_ign):
Metapackage which provides all the other packages.
* [ros_ign_image](https://github.com/osrf/ros_ign/tree/dashing/ros_ign_image):
Unidirectional transport bridge for images from
[Ignition Transport](https://ignitionrobotics.org/libs/transport)
to ROS using
[image_transport](http://wiki.ros.org/image_transport).
* [ros_ign_bridge](https://github.com/osrf/ros_ign/tree/dashing/ros_ign_bridge):
Bidirectional transport bridge between
[Ignition Transport](https://ignitionrobotics.org/libs/transport)
and ROS.
* [ros_ign_gazebo](https://github.com/osrf/ros_ign/tree/dashing/ros_ign_gazebo):
Convenient launch files and executables for using
[Ignition Gazebo](https://ignitionrobotics.org/libs/gazebo)
with ROS.
* [ros_ign_gazebo_demos](https://github.com/osrf/ros_ign/tree/dashing/ros_ign_gazebo_demos):
Demos using the ROS-Ignition integration.
* [ros_ign_point_cloud](https://github.com/osrf/ros_ign/tree/dashing/ros_ign_point_cloud):
Plugins for publishing point clouds to ROS from
[Ignition Gazebo](https://ignitionrobotics.org/libs/gazebo) simulations.
4 changes: 4 additions & 0 deletions ros_ign/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# ROS-Ignition packages

`ros_ign` is a metapackage that installs all packages integrating
[ROS](http://www.ros.org/) and [Ignition](https://ignitionrobotics.org):
59 changes: 40 additions & 19 deletions ros_ign_bridge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@ service calls. Its support is limited to only the following message types:
| rosgraph_msgs/Clock | ignition::msgs::Clock |
| sensor_msgs/BatteryState | ignition::msgs::BatteryState |
| sensor_msgs/CameraInfo | ignition::msgs::CameraInfo |
| sensor_msgs/FluidPressure (TODO) | ignition::msgs::FluidPressure (TODO) |
| sensor_msgs/Imu | ignition::msgs::IMU |
| sensor_msgs/Image | ignition::msgs::Image |
| sensor_msgs/JointState | ignition::msgs::Model |
| sensor_msgs/LaserScan | ignition::msgs::LaserScan |
| sensor_msgs/MagneticField | ignition::msgs::Magnetometer |
| sensor_msgs/PointCloud2 | ignition::msgs::PointCloudPacked |

Run `ros2 run ros_ign_bridge parameter_bridge -h` for instructions.

## Prerequisites

* ROS 2 [Dashing](https://index.ros.org/doc/ros2/Installation/Dashing)
Expand All @@ -45,25 +48,43 @@ source installed.

1. Create a colcon workspace:

```
# Setup the workspace
mkdir -p ~/bridge_ws/src
cd ~/bridge_ws/src

# Download needed software
git clone https://github.com/osrf/ros_ign.git
```

2. Build the workspace:

```
# Source ROS distro's setup.bash
source /opt/ros/dashing/setup.bash

# Build and install into workspace
cd ~/bridge_ws/
colcon build
```
```
# Setup the workspace
mkdir -p ~/bridge_ws/src
cd ~/bridge_ws/src

# Download needed software
git clone https://github.com/osrf/ros_ign.git -b dashing
```

1. Install ROS dependencies:

```
cd ~/bridge_ws
rosdep install --from-paths src -i -y --rosdistro dashing \
--skip-keys=ignition-gazebo2 \
--skip-keys=ignition-gazebo3 \
--skip-keys=ignition-msgs4 \
--skip-keys=ignition-msgs5 \
--skip-keys=ignition-rendering2 \
--skip-keys=ignition-rendering3 \
--skip-keys=ignition-sensors2 \
--skip-keys=ignition-sensors3 \
--skip-keys=ignition-transport7 \
--skip-keys=ignition-transport8

```

1. Build the workspace:

```
# Source ROS distro's setup.bash
source /opt/ros/dashing/setup.bash

# Build and install into workspace
cd ~/bridge_ws/
colcon build
```

## Example 1a: Ignition Transport talker and ROS 2 listener

Expand Down
2 changes: 1 addition & 1 deletion ros_ign_bridge/src/parameter_bridge.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ enum Direction
//////////////////////////////////////////////////
void usage()
{
std::cerr << "Bridge a collection of ROS2 and Ignition Transport topics.\n\n" <<
std::cout << "Bridge a collection of ROS2 and Ignition Transport topics.\n\n" <<
" parameter_bridge <topic@ROS2_type@Ign_type> .. " <<
" <topic@ROS2_type@Ign_type>\n\n" <<
"The first @ symbol delimits the topic name from the message types.\n" <<
Expand Down
4 changes: 4 additions & 0 deletions ros_ign_gazebo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# ROS + Ignition Gazebo

This package hasn't been ported to ROS 2 yet.