Skip to content

Commit

Permalink
Update nav2_demo readme after introducing space_nav2_bringup package (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
xfiderek committed Oct 2, 2024
1 parent ffda8ce commit 3e02f24
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
4 changes: 2 additions & 2 deletions nav2_demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ Start the space_nav2 container and launch the navigation2 nodes:

```
./run.sh
ros2 launch nav2_bringup navigation_launch.py use_sim_time:=True params_file:=nav2_params.yaml
ros2 launch space_nav2_bringup navigation_launch.py use_sim_time:=True params_file:=nav2_params.yaml
```

## Terminal 3 - launch localization with map

```
docker exec -it osrf_space_nav2_demo bash
source install/setup.bash
ros2 launch nav2_bringup localization_launch.py use_sim_time:=True map:=mars_map.yaml
ros2 launch space_nav2_bringup localization_launch.py use_sim_time:=True map:=mars_map.yaml params_file:=nav2_params.yaml
```

## Terminal 4 - launch Rviz
Expand Down
9 changes: 7 additions & 2 deletions navigation2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ spaceros-user@ip-your-ip-address:/home/spaceros-user/nav2_ws#

To run the latest demo, see the README in the [nav2_demo](../nav2_demo/README.md) folder.


## Updating navigation2 packages

The `navigation2.repos` file available in this repository provides a list of repos that are required to build the nav2 stack. ROS packages already included in the SpaceROS base image are omited from this file.

To update navigation2 packages used to build the space nav2 image, run the `docker_update_nav2_repos.sh` script:
Expand All @@ -69,5 +69,10 @@ To update navigation2 packages used to build the space nav2 image, run the `dock

This will update the `navigation2.repos` file with the newest versions of nav2 packages. The script resolves missing packages in base spaceros image and creates a list with their latest versions. The `navigation2.repos` file is then copied during build to the docker image with space nav2, and packages specified in the file are cloned and installed.

To generate a list of required packages for any other ROS workspace (e.g. your custom workspace built on top of SpaceROS that already has some nav2 dependencies installed), consider using the `update_nav2_repos.sh` as your starting point. You may also need to clone `generate-repos.sh` script from the main spaceros repository.
By default, this update nav2 repositories using the latest released version of the Space ROS base image (typically `osrf/space-ros:latest`).
If building locally, the underlying base image can be set in the through the environment with:
```
SPACE_ROS_IMAGE=osrf/space-ros:main ./docker_update_nav2_repos.sh
```

To generate a list of required packages for any other ROS workspace (e.g. your custom workspace built on top of SpaceROS that already has some nav2 dependencies installed), consider using the `update_nav2_repos.sh` as your starting point. You may also need to clone `generate-repos.sh` script from the main spaceros repository.

0 comments on commit 3e02f24

Please sign in to comment.