Skip to content

Commit 45d8668

Browse files
committed
Update README
Signed-off-by: Gerardo Puga <glpuga@gmail.com>
1 parent 59e685d commit 45d8668

File tree

6 files changed

+47
-37
lines changed

6 files changed

+47
-37
lines changed

README.md

Lines changed: 47 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
# AR4 ROS 2 Software
22

3-
The [Annin Robotics AR4](https://www.anninrobotics.com/) robot is a 6DOF desktop size industrial robot that is a free, open plan low cost robot. This repository contains the necessary ROS 2 packages to plan and execute motions in Gazebo sim.
3+
The [Annin Robotics AR4](https://www.anninrobotics.com/) robot is a 6DOF desktop size industrial robot that is a free, open plan low cost robot.
44

5-
It provides a ROS 2 set of packages to be able to control the AR4 robot both in real hardware and
6-
a number of different simulation environments.
5+
This package is a ROS 2 software stack for the AR4 robot. It contains both the necessary packages to control the robot in real hardware and in simulation environments based on [Gazebo](https://gazebosim.org/home), [Isaac Sim](https://docs.isaacsim.omniverse.nvidia.com/latest/index.html), and [MuJoCo](https://mujoco.org/).
76

8-
<p align="center">
9-
<img src="docs/ar4.png" width=500 />
10-
</p>
7+
https://github.com/user-attachments/assets/0edf4c30-70d1-4992-a5ee-e3e813877bb5
118

12-
## Package Summary
9+
10+
## Package summary
1311

1412
These are the main packages providing launch files for the different use cases:
1513

1614
- [`ar4_description`](./ar4_description): Contains the platform-agnostic parts of the URDF robot description.
1715
- [`ar4_gazebo_bringup`](./ar4_gazebo): Launch a Gazebo Sim simulation of AR4.
1816
- [`ar4_isaac_bringup`](./ar4_gazebo): **Not yet available.** Launch an Isaac Sim simulation of AR4.
19-
- [`ar4_mujoco_bringup`](./ar4_gazebo): **Not yet available.** Launch a Mujoco-based simulation of AR4.
17+
- [`ar4_mujoco_bringup`](./ar4_gazebo): **Not yet available.** Launch a MuJoCo-based simulation of AR4.
2018
- [`ar4_realbot_bringup`](./ar4_gazebo): Launch drivers and control software for the real AR4 robot.
2119
- [`ar4_isaac`](./ar4_isaac): Isaac simulation for the ar4 arm.
2220

@@ -34,14 +32,14 @@ graph TD
3432
A --> F
3533
C --> F
3634
37-
H[**ar4_isaac_bringup** <br> main.launch.py <br> ...not yet available...]
38-
I[**...** <br> main.launch.py]
35+
H[**ar4_isaac_bringup** <br> main.launch.py]
36+
I[**ar4_isaac_sim** <br> main.launch.py]
3937
4038
B --> H
4139
I --> H
4240
43-
J[**ar4_mujoco_bringup** <br> main.launch.py <br> ...not yet available...]
44-
K[**...** <br> main.launch.py]
41+
J[**ar4_mujoco_bringup** <br> main.launch.py]
42+
K[**ar4_mujoco_sim** <br> main.launch.py]
4543
4644
B --> J
4745
K --> J
@@ -59,43 +57,62 @@ graph TD
5957
F --> G
6058
```
6159

62-
## Installation
60+
## Prerequisites
61+
62+
You need a working ROS 2 environment to be able to build and run the packages in this repository. The exact details of the environment will depend on the specific package you are trying to run (realbot, Gazebo, Isaac Sim, or MuJoCo).
63+
64+
To help you get started and to provide a reference environment, we provide development docker images that contain all the necessary dependencies to run the contents of this repository.
65+
66+
To be able to use the development docker images, you need to have `docker` and `docker-compose` installed in your host machine.
6367

64-
### Prerequisites
68+
You can find the Docker installation instructions for Ubuntu [here](https://docs.docker.com/engine/install/ubuntu/).
6569

66-
It is a requirement to have `docker engine` with the `docker compose plugin` already installed in the host machine.
70+
## Running on simulated environments
6771

68-
See: [Docker Installation Guide](https://docs.docker.com/engine/install/ubuntu/)
72+
The AR4 robot can be run using different simulators. The following sections describe how to launch the AR4 robot in Gazebo, Isaac Sim, and MuJoCo.
73+
74+
### Gazebo
75+
76+
To run the AR4 robot in Gazebo Sim use the `ar4_gazebo` version of the development docker image.
77+
78+
```bash
79+
./docker/run.sh -s ar4_gazebo --build
80+
```
6981

70-
### Running the dev container
82+
See further instructions in [the Gazebo bringup package README file](ar4_gazebo_bringup/README.md)
7183

72-
Build and run the container for the use case you are interested in
84+
![Ar4 Gazebo](media/ar4_gazebo.png)
7385

74-
#### Gazebo
86+
### Isaac sim
7587

76-
Launch the docker container with the following command:
88+
To run the AR4 robot in Isaac Sim use the `ar4_isaac` version of the development docker image.
7789

7890
```bash
79-
./docker/run.sh -s ar4_gazebo
91+
./docker/run.sh -s ar4_isaac --build
8092
```
8193

82-
Then build and launch Gazebo bringup launch file:
94+
See further instructions in [the Isaac Sim bringup package README file](ar4_isaac/README.md)
95+
96+
![Ar4 Isaac](media/ar4_isaac.png)
97+
98+
### MuJoCo
99+
100+
To run the AR4 robot in MuJoCo use the `ar4_mujoco` version of the development docker image.
83101

84102
```bash
85-
colcon build --symlink-install --packages-up-to ar4_gazebo_bringup \
86-
&& source install/setup.bash \
87-
&& ros2 launch ar4_gazebo_bringup main.launch.py
103+
./docker/run.sh -s ar4_mujoco --build
88104
```
89105

90-
![Ar4 Gazebo](docs/ar4.png)
106+
See further instructions in [the MuJoCo bringup package README file](ar4_mujoco_bringup/README.md)
91107

108+
![Ar4 MuJoCo](media/ar4_mujoco.png)
92109

93-
#### Hardware
94110

95-
* [Hardware Interface Instructions](ar4_hardware_interface/README.md)
111+
## Using on real hardware
96112

113+
See further instructions in [the Realbot bringup package README file](ar4_realbot_bringup/README.md)
97114

98-
### Controlling the AR4 with MoveIt
115+
## Controlling the AR4 with MoveIt
99116

100117
To plan and command the arm to execute a motion, this launch file will also start MoveIt automatically. Once launched, you should see RViz showing the robot visualization and the MotionPlanning panel on the left.
101118

@@ -110,18 +127,11 @@ This will select a random position for the arm that would not cause a collision
110127
[Random valid position video](https://github.com/user-attachments/assets/ec926968-8952-4ccf-ba63-5423e94f61cd)
111128

112129

113-
#### 2. Moving end effector to a desired position
130+
### 2. Moving end effector to a desired position
114131
This allows you to select a goal position for the end effector, which is currently the last link in the arm as no gripper is being used. This is done by dragging and dropping where the end effector should move to.
115132

116133
[User selected position video](https://github.com/user-attachments/assets/04dbb11c-bca4-4c05-95ae-251d70f41931)
117134

118-
119-
## Isaac sim
120-
121-
![Ar4 Isaac](docs/ar4_isaac.png)
122-
123-
See: [Isaac Sim Instructions](ar4_isaac/README.md)
124-
125135
## Licenses
126136

127137
All packages in this repository except for `ar4_description` and `ar4_hardware_interface` are distributed under a **BSD 3-Clause** License.

docs/ar4.png

-114 KB
Binary file not shown.

media/ar4_gazebo.png

196 KB
Loading
File renamed without changes.

media/ar4_isaac_ppp.png

233 KB
Loading

media/ar4_mujoco.png

515 KB
Loading

0 commit comments

Comments
 (0)