|
1 |
| -# O3DE ROS2 Gem |
| 1 | +# O3DE ROS 2 Gem |
2 | 2 |
|
3 |
| -With the ROS2 Gem you can develop robotic simulations with [ROS (Robot Operating System) 2](https://www.ros.org/) in Open 3D Engine (O3DE). |
| 3 | +With the ROS 2 Gem you can develop robotic simulations with [ROS (Robot Operating System) 2](https://www.ros.org/) in [Open 3D Engine (O3DE)](https://o3de.org). |
4 | 4 |
|
5 |
| -Access the the whole ROS2 Gem documentation by clicking [here](https://www.o3de.org/docs/user-guide/interactivity/robotics/). Other sections in this README link to specific parts of the provided documentation. |
| 5 | +### Platform |
| 6 | +The Gem is tested with ROS 2 Humble and Iron on Ubuntu 22.04. ROS 2 Jazzy support will be available on distro release day. |
| 7 | + |
| 8 | +>> The Gem is not available for Windows and does not support ROS 1. |
| 9 | +
|
| 10 | +## Installation |
| 11 | + |
| 12 | +Refer to [this part of the documentation](https://www.o3de.org/docs/user-guide/interactivity/robotics/project-configuration/) to learn how to create a new project with the ROS 2 Gem. |
| 13 | + |
| 14 | +## Documentation |
| 15 | + |
| 16 | +A great place to start learning about this Gem is the [O3DE Robotics Documentation](https://www.o3de.org/docs/user-guide/interactivity/robotics/). |
6 | 17 |
|
7 | 18 | ## Features
|
8 | 19 |
|
9 |
| -* Direct and natural support of ROS2 ecosystem: |
10 |
| - * No bridges. Your simulation node will function as any other ROS2 node. |
11 |
| - * This is also good for performance |
12 |
| - * Easy way to include ROS2 dependencies. |
| 20 | +* Direct and natural support of ROS 2 ecosystem: |
| 21 | + * No bridges. Your simulation node will function as any other ROS 2 node. You can write ROS 2 code in simulation! |
| 22 | + * This is also good for performance. |
| 23 | + * Easy way to include ROS 2 dependencies. |
| 24 | + * "Just works" with custom messages, services and actions. |
13 | 25 | * Sensors:
|
14 |
| - * Sensor Component serving as a handy abstraction. |
15 |
| - * Example implementations of Lidar, Camera, IMU sensors. |
16 |
| - * Including a few Assets and prefabs which are ready to use. |
| 26 | + * Customizable sensors: Lidar3D, Lidar2D, Camera, IMU, Odometry, GNSS, Contact. |
| 27 | + * Easy to implement other sensors through handy abstractions. |
| 28 | +* Robot control and dynamics components: |
| 29 | + * A quick to use method of controlling your mobile robot with Twist or Ackermann messages. |
| 30 | + * Control and state components for joint systems, such as robotic manipulator arms. |
| 31 | + * Vacuum and finger grippers. |
| 32 | +* Robot Importer feature working with `URDF` and `SDFormat` (including `.xacro` and `.world` files) |
| 33 | + * Plugin support which allows you to import robots with sensors already there! |
17 | 34 | * Automated handling of:
|
18 | 35 | * Simulation time, publishing `/clock` supporting non-real time.
|
19 | 36 | * Publishing of transformation frames (`/tf`, `/tf_static`).
|
20 | 37 | * Validation for topic and namespace names.
|
21 |
| -* Robot Control Component: |
22 |
| - * A quick to use method of controlling your robot with Twist messages. |
23 |
| - * Can be used with custom LUA scripting. |
24 | 38 |
|
25 | 39 | For a "feel" of these features, see an [example project](#example-project) which uses this Gem to run navigation stack.
|
26 | 40 |
|
27 |
| -## Example project |
28 |
| - |
29 |
| -You can test the O3DE ROS2 Gem with the [Robot Vacuum](https://github.com/o3de/RobotVacuumSample) project. It will allow you to run a robot navigation simulation. All necessary assets are included. |
30 |
| - |
31 |
| -## Installation |
32 |
| - |
33 |
| -Refer to [this part of the documentation](https://www.o3de.org/docs/user-guide/interactivity/robotics/project-configuration/) to configure your project with the ROS2 Gem. |
34 |
| - |
35 |
| - |
36 |
| -## Learn about ROS2 Gem |
37 |
| - |
38 |
| -Visit [this part of the documentation](https://www.o3de.org/docs/user-guide/interactivity/robotics/concepts-and-components-overview/) to learn about the ROS2 Gems Concepts and Structure. Additionally you can learn about ROS 2 Concepts [here](https://docs.ros.org/en/humble/Concepts.html). |
39 |
| - |
40 |
| -## How to create your own robotic simulation |
41 |
| - |
42 |
| -Refer [here](https://www.o3de.org/docs/user-guide/interactivity/robotics/creating-robotic-simulation/) to access a list of steps guiding you through the creation of your own simulation. |
43 |
| - |
44 | 41 | ## Importing robots
|
45 | 42 |
|
46 |
| -Access [this part](https://www.o3de.org/docs/user-guide/interactivity/robotics/importing-robot/) of the documentation to learn about importing robots from common formats such as the [Unified Robot Description Format (URDF)](http://wiki.ros.org/urdf). |
| 43 | +Please refer to [Robot Importer documentation](https://www.o3de.org/docs/user-guide/interactivity/robotics/importing-robot/). |
47 | 44 |
|
48 | 45 | ## Troubleshooting
|
49 | 46 |
|
50 |
| -If you have any problems with the ROS2 Gem, visit [here](https://www.o3de.org/docs/user-guide/interactivity/robotics/troubleshooting/) for troubleshooting guides and suggestions. |
| 47 | +See [Troubleshooting guide](https://www.o3de.org/docs/user-guide/interactivity/robotics/troubleshooting/). |
51 | 48 |
|
52 | 49 | ## User Guides
|
53 | 50 |
|
|
0 commit comments