> For the complete documentation index, see [llms.txt](https://roar.gitbook.io/roar_py-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://roar.gitbook.io/roar_py-documentation/readme.md).

# Introduction

## ROAR\_PY

ROAR\_PY is ROAR team's new control suite for controlling vehicles and robots. 

Checkout our repository [here](https://github.com/augcog/ROAR_PY).

It is a combination of an **abstract layer that unifies the controls** of robots/vehicles regardless of their actual hardware configuration and **actual implementation layers that sends control commands** to the actual running hardware.

Reasons you should adopt ROAR\_PY

1. It is a general framework for unifying control programs
2. It is RL-friendly! All ROAR\_PY sensor/actor interfaces are compatible with the Gymnasium framework
3. ROAR\_PY supports streaming actor controls / sensor readings over websockets or other custom protocols over ethernet / usb cables through minimal code changes

## Project Information

| Role                     | Name        | Contact                                             |
| ------------------------ | ----------- | --------------------------------------------------- |
| Lead                     | Yunhao Cao  | [quantumcookie.xyz](https://www.quantumcookie.xyz/) |
| Contributor / Maintainer | Carl Gan    | <https://www.linkedin.com/in/qianxin-gan>           |
| Documentation Help       | Harris Song |                                                     |

## Acknowledgements

ROAR\_PY's documentation is graciously supported by Gitbook's Community(Education) Plan.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://roar.gitbook.io/roar_py-documentation/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.