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

Updates readme. #80

Merged
merged 3 commits into from
Aug 28, 2024
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
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Andino Gazebo Simulation


<img src="./docs/media/andino_gz.png" width="800"/>
<img src="./docs/media/populated_office_1.png" width="800"/>

## :clipboard: Description

Expand Down Expand Up @@ -47,13 +47,16 @@ source install/setup.bash

### Andino simulation

<img src="./docs/media/andino_gz.png" width="800"/>


Once the package is built and sourced, you can start a simulation.

```sh
ros2 launch andino_gz andino_gz.launch.py
```

_Note: You can use `--world_name` flag to indicate other [world](andino_gz/worlds/) to use. (For example: `depot.sdf`(default), `office.sdf`, `empty.sdf`)_
_Note: You can use `world_name` flag to indicate other [world](andino_gz/worlds/) to use. (For example: `depot.sdf`(default), `office.sdf`, `populated_office.sdf`, `empty.sdf`)_

By default the ros bridge and rviz are initialized. In case you prefer to disable any of those you can do it via its flags:

Expand All @@ -66,6 +69,14 @@ To see a complete list of available arguments for the launch file do:
ros2 launch andino_gz andino_gz.launch.py --show-args
```

Using a different world:
```sh
ros2 launch andino_gz andino_gz.launch.py world_name:=populated_office.sdf
```

<img src="./docs/media/populated_office_2.png" width="800"/>


Make sure to review the required topics using `ign topics` and `ros2 topic` CLI tools.
Also, consider using looking at the translation entries under `andino_gz/config/bridge_config.yaml`.

Expand Down Expand Up @@ -121,6 +132,19 @@ Also, consider using looking at the translation entries under `andino_gz/config/

Once Gazebo window pops up, play the simulation using the gui.

**Important!**:
- When using `nav2` flag, the `map` must match the selected `world`. For example:
- For `depot.sdf` world, the map need to be `depot`:
```
ros2 launch andino_gz andino_gz.launch.py nav2:=True world_name:=depot.sdf map:=depot
```
Typically, as this is the default world-map, there is no need to indicate them.
- For `office.sdf` and `populated_office.sdf` worlds, the map need to be `office`:
```
ros2 launch andino_gz andino_gz.launch.py nav2:=True world_name:=office.sdf map:=office
```


2. An RViz window will be spawned for each robot so it can be controlled independently. Use `2D Pose Estimate` to pass a hint to AMCL where is the initial point

Note you have to do it per robot, namely, per RViz window.
Expand Down
Binary file removed andino_gz/models/office.stl
Binary file not shown.
Binary file added docs/media/populated_office_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/populated_office_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading