Skip to content

Commit 0b2feac

Browse files
committed
ROS 2 sourcing policy in documentation
Signed-off-by: Piotr Jaroszek <[email protected]>
1 parent dff3103 commit 0b2feac

File tree

2 files changed

+25
-3
lines changed
  • docs

2 files changed

+25
-3
lines changed

docs/Components/ROS2/ROS2ForUnity/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ All required dependencies are installed and can be used e.g. as a complete set o
2121
Only asset libraries and generated messages are installed therefore *ROS2* instance must be sourced.
2222

2323
By default, asset `R2FU` in *AWSIM* is prepared in *standalone mode*.
24-
Thanks to this, *ROS2* instance doesn't need to be sourced - all you have to do is run the *Unity* editor.
24+
25+
!!! warning
26+
27+
To avoid internal conflicts between the standalone libraries, and sourced ones, *ROS2* instance shouldn't be sourced before running AWSIM or the *Unity* Editor.
2528

2629
!!! question "Can't see topics"
2730
There are no errors but I can't see topics published by `R2FU`

docs/GettingStarted/SetupUnityProject/index.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,24 @@ This page is a tutorial for setting up a AWSIM Unity project.
2323
2. Prepare a desktop PC with Windows 10 or 11 (64 bit) installed.
2424
3. Install [git](https://git-scm.com/).
2525

26+
### ROS 2
27+
28+
AWSIM comes with a *standalone* flavor of [`Ros2ForUnity`](../../Components/ROS2/ROS2ForUnity/index.md). This means that, to avoid internal conflicts between different ROS 2 versions, you shouldn't run the Editor or AWSIM binary with ROS 2 sourced.
29+
30+
!!! warning
31+
32+
Do not run the AWSIM, Unity Hub, or the Editor with ROS 2 sourced.
33+
34+
=== "Ubuntu 22"
35+
- Make sure that the terminal which you are using to run Unity Hub, Editor, or AWSIM doesn't have ROS 2 sourced.
36+
- It is common to have ROS 2 sourced automatically with `~/.bashrc` or `~/.profile`. Make sure it is not obscuring your working environment:
37+
- Running Unity Hub from the Ubuntu GUI menu takes the environment configuration from `~/.profile`.
38+
- Running Unity Hub from the terminal uses the current terminal configuration from `~/.profile` and `~/.bashrc`.
39+
- Running Unity Editor from the UnityHub inherits the environment setup from the Unity Hub.
40+
41+
=== "Windows"
42+
- Make sure your Windows environment variables are ROS 2 free.
43+
2644
### Unity installation
2745

2846
!!! info
@@ -56,7 +74,8 @@ Follow the steps below to install Unity on your machine:
5674
### Open AWSIM project
5775

5876
To open the Unity AWSIM project in Unity Editor:
59-
1. Make sure you have the AWSIM repository cloned
77+
78+
1. Make sure you have the AWSIM repository cloned and ROS 2 is not sourced.
6079
```
6180
git clone [email protected]:tier4/AWSIM.git
6281
```
@@ -66,7 +85,7 @@ To open the Unity AWSIM project in Unity Editor:
6685
./UnityHub.AppImage
6786
```
6887
69-
3. Open the project in UnityHub
88+
3. Open the project in UnityHub.
7089
- Click the `Open` button
7190
![](image_6.png)
7291

0 commit comments

Comments
 (0)