Skip to content

Commit 95a7985

Browse files
authored
Update README.md
1 parent 94e4689 commit 95a7985

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,29 @@ It uses http://mongoc.org/libbson/ to encode and decode the whole ROS communicat
3838
Since BSON is not included in Unreal Engine (yet), its code has to be added to this plugin.
3939
Currently, this plugin comes with a pre-compiled libbson for Windows x64 and Linux x64 which doesn't need any additional configuration.
4040

41-
To enable the communcation between Unreal and ROS, you will need a running ROSBridge (https://github.com/RobotWebTools/rosbridge_suite) with bson_mode. As an example for ROS kinetic, you can install it with:
41+
To enable the communcation between Unreal and ROS, you will need a running ROSBridge (https://github.com/RobotWebTools/rosbridge_suite) with bson_mode. Note: Please use rosbridge with version=>0.8.0 to get full BSON support.
42+
43+
The recommended way to install rosbridge is from source (requires the `rosauth` package):
44+
```
45+
sudo apt-get install rosauth
46+
cd ~/ros_workspace/
47+
git clone -b ros1 https://github.com/RobotWebTools/rosbridge_suite.git
48+
cd ..
49+
catkin_make
50+
source devel/setup.bash
51+
```
52+
Even though you could install rosbridge using apt via:
4253
```
4354
sudo apt-get install ros-kinetic-rosbridge-suite
4455
```
45-
Note: Please use rosbridge with version=>0.8.0 to get full BSON support. After installing rosbridge, you can enable the bson_mode like this:
56+
if you were using ROS Kinetic, there have been numersous issues where these apt packages do not reflect the code in the `ros1` branch. Hence, it is best to install from source. After installing rosbridge, you can enable the bson_mode like this:
4657

4758
```
4859
roslaunch rosbridge_server rosbridge_tcp.launch bson_only_mode:=True
4960
```
50-
**Important**: The most recent rosbridge versions changed the transmission method. Since ROSIntegration can not handle this new method yet, please make sure to check out these issue on how to install a compatible rosbridge version: https://github.com/code-iai/ROSIntegration/issues/141 & https://github.com/code-iai/ROSIntegration/issues/139
61+
If UE4 and rosbridge are both running, then you should see the rosbridge node subscribe to two topics beginning with `/unreal_ros/`. If you do NOT see this, then you likely have a problem with your rosbridge installation.
62+
63+
<!-- **Important**: The most recent rosbridge versions changed the transmission method. Since ROSIntegration can not handle this new method yet, please make sure to check out these issue on how to install a compatible rosbridge version: https://github.com/code-iai/ROSIntegration/issues/141 & https://github.com/code-iai/ROSIntegration/issues/139 -->
5164

5265
In our testing, we usually installed rosbridge on a Ubuntu Linux with ROS while the UE4 with ROSIntegration can be run on a Windows or Linux hosts. ROSBridge and UE4 with ROSIntegration don't need to be run on the same machine. So in order to run UE4 with ROSIntegration on Windows, you can either install a Linux Virtual Machine on your Windows Hosts or have a seperate, physical machine with Linux running in your network.
5366

0 commit comments

Comments
 (0)