Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,43 @@
# ROSplane
<p>
<a href="https://github.com/rosflight/rosplane/actions/workflows/ros2-ci.yml">
<img src="https://github.com/rosflight/rosplane/actions/workflows/ros2-ci.yml/badge.svg" alt="ROSplane CI" />
</a>
</p>

[![ROS2 CI](https://github.com/rosflight/rosplane/actions/workflows/ros2-ci.yml/badge.svg)](https://github.com/rosflight/rosplane/actions/workflows/ros2-ci.yml)
<p align="center">
<img src="rosplane_logo.png" alt="ROSplane logo" width=500 />
</p>

ROSplane is a basic fixed-wing autopilot build around ROS2 for use with the ROSflight autopilot. It is a continuation of the original [ROSplane](https://github.com/byu-magicc/rosplane) project. It is built according to the methods published in Small Unmanned Aircraft: Theory and Practice by Dr. Randy Beard and Dr. Tim McLain.
<div align="center">
<video autoplay loop src="https://github.com/user-attachments/assets/3eb63328-0d64-40fd-9a84-f6d08e309d10">
</div>
<div align="center">
<video autoplay loop src="https://github.com/user-attachments/assets/3ea93ae4-b5b1-401b-af17-5df8cfbfc29f">
</div>

For more information, see the [ROSflight documentation](https://docs.rosflight.org/git-main/user-guide/concepts/rosplane-overview/).
ROSplane is a basic fixed-wing autopilot build around ROS2 for use with the ROSflight autopilot.
It is a continuation of the original [ROSplane](https://github.com/byu-magicc/rosplane) project.
It is built according to the methods published in *Small Unmanned Aircraft: Theory and Practice* by Dr. Randy Beard and Dr. Tim McLain.

## Installation, Descriptions, Usage
For more information, see the [ROSflight documentation](https://docs.rosflight.org), which contains installation, general descriptions, and tutorials for how to use ROSplane.

## Quick start (for ROS2 users)

For more detailed instructions, see the documentation link above.

1. Clone this repo into a ROS2 workspace
2. `colcon build`
3. Launch autopilot stack with:
```bash
ros2 launch rosplane rosplane.launch.py
```
or if in sim:
```bash
ros2 launch rosplane_sim sim.launch.py
```

## Acknowledgements
A special thanks is due to the developers of ROSplane v1.0. Their work allowed for the project in its current form.
These include Gary Ellingson, who did much of the original development into C++ of these algorithms.
Thanks are also due to Judd Mehr and Brian Russel who adapted work for ROSplane.
Binary file added rosplane_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.