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

Restructuring ROS 2 Gem docs #2266

Merged
merged 10 commits into from
Mar 20, 2023
Merged
2 changes: 1 addition & 1 deletion content/docs/user-guide/gems/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ toc: true

| Gem | Description |
| - | - |
| [ROS 2](./ros2/) | The ROS 2 Gem provides integration with the [Robot Operating System (ROS) 2](https://docs.ros.org/en/rolling/index.html) library and enables design of simulation of robotics systems. |
| [ROS 2](./robotics/ros2.md) | The ROS 2 Gem provides integration with the [Robot Operating System (ROS) 2](https://docs.ros.org/en/rolling/index.html) library and enables the design of the simulation of robotics systems. |

## Script

Expand Down
42 changes: 42 additions & 0 deletions content/docs/user-guide/gems/reference/robotics/ros2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
linkTitle: ROS 2
title: ROS 2 Gem
description: The ROS 2 Gem helps build robotic simulations with Robot Operating System (ROS) 2 in Open 3D Engine (O3DE).
toc: true
---

<!-- # O3DE ROS2 Gem -->

The **ROS 2 Gem** uses the [Robot Operating System (ROS)](https://docs.ros.org/en/rolling/index.htmml) to enable
robotic simulation in **Open 3D Engine (O3DE)**. The ROS 2 Gem has the following features:

* Direct and natural support of the ROS 2 ecosystem:
* Does not use any bridges to communicate between ROS and O3DE. A simulation node will function as any other ROS 2 node.
* Enables you to directly include ROS 2 headers and write ROS 2 code in O3DE.
michalpelka marked this conversation as resolved.
Show resolved Hide resolved
* Having no bridge improves communication performance.
* Provides an easy way to include ROS 2 dependencies.
* Sensors:
* Are abstracted through the Sensor Component, which takes care of the publishing of sensor data and common settings such as frequency.
* Features several types of configurable, extendable sensors such as Lidar, Camera (including Depth channel), IMU, and GNSS.
* Utilities for automated handling of:
* Simulation time: - publishing `/clock`, with support for non-real time.
* Computing and publishing of transformation frames (`/tf`, `/tf_static`).
* Namespaces- allowing multi-robot simulation in O3DE by default!
* Validation for topic and namespace names.
* Dynamic spawning of robots through ROS 2 services.
* Robot Control Component:
* Provides a quick-to-use method of controlling your robot.
* Includes support for Twist and AckermannDrive message interfaces.
* Vehicle dynamics:
* Ackermann Steering subscribes to the message of type [AckermannDrive](http://docs.ros.org/en/api/ackermann_msgs/html/msg/AckermannDrive.html).
* Differential drive subscribes to the message of type [Twist](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Twist.html).
* URDF/XACRO (experimental).
* Allows robot imports from the URDF format.

## Related topics

| Topic | Description |
|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
| [Robotics in O3DE](/docs/user-guide/interactivity/robotics) | Learn about robotics in O3DE, including Gems, Templates and demos to help you get started. |
| [ROS 2 Gem Concepts and Structure](/docs/user-guide/interactivity/robotics/concepts-and-components-overview.md) | Overview of the concepts and structure of the ROS 2 Gem, including an overview of its components |
| [ROS 2 Gem API reference](/docs/api/gems/ros2) | Generated documentation for ROS 2 Gem's API reference. |
124 changes: 0 additions & 124 deletions content/docs/user-guide/gems/reference/ros2/_index.md

This file was deleted.

Loading