Skip to content

Commit

Permalink
Update documentation for the modified instructions in canadarm2 demo
Browse files Browse the repository at this point in the history
 - Update Makefile help
 - Update demo instructions for gazebosim and isaac sim
  • Loading branch information
franklinselva committed Aug 23, 2024
1 parent 17e6330 commit b81421f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
8 changes: 4 additions & 4 deletions canadarm2/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ help:
@echo "Commands:"
@echo " make help - Show this help message"
@echo " make clean - Clean the local workspace"
@echo " make gazebosim build - Build the Gazebo workspace"
@echo " make gazebosim run - Run the Gazebo simulation"
@echo " make isaacsim build - Build the IsaacSim workspace"
@echo " make isaacsim run - Run the IsaacSim simulation"
@echo " make gazebosim-build - Build the Gazebo workspace"
@echo " make gazebosim-run - Run the Gazebo simulation"
@echo " make isaacsim-build - Build the IsaacSim workspace"
@echo " make isaacsim-run - Run the IsaacSim simulation"

# Build the Docker image
.PHONY: build-docker
Expand Down
14 changes: 10 additions & 4 deletions canadarm2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ To start the demo, there are few dependencies that need to be installed. The fol

1. You will need ROS Humble on your host system. If it is not already installed, you can follow the instructions [here](https://docs.ros.org/en/humble/Installation.html).
2. You will need Gazebo Sim installed on your system. If not, you can follow the instructions [here](https://gazebosim.org/docs/all/getstarted/).
3. You will need docker installed on your system. If not, you can follow the instructions [here](https://docs.docker.com/get-docker/).
4. Install xterm for running the demo. You can install it using the following command.
3. You will need Nvidia's Isaac Sim installed on your system. If not, you can follow the instructions [here](https://docs.omniverse.nvidia.com/isaacsim/latest/installation/install_workstation.html).
4. You will need docker installed on your system. If not, you can follow the instructions [here](https://docs.docker.com/get-docker/).
5. Install xterm for running the demo. You can install it using the following command.
```bash
sudo apt-get install xterm
```
Expand All @@ -29,8 +30,13 @@ To start the demo, there are few dependencies that need to be installed. The fol
# To see the list of available commands
make help
# To build and run the demo
make run
# To build and run the demos for the canadarm2
make gazebosim-build
make gazebosim-run
# To build and run the demos for the canadarm2 with Isaac Sim
make isaacsim-build
make isaacsim-run # Note: This will not kickstart the Isaac Sim. You will have to start it manually and load the scene.
```

This will start the demo in one terminal and gazebo in another terminal. To control the canadarm2, we provide ros2 services for the demo. You can control the rover using the following services.
Expand Down

0 comments on commit b81421f

Please sign in to comment.