Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
makeecat authored Aug 1, 2024
1 parent f0c674b commit 6344d8e
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,32 @@
# Peng
Peng is a minimal Rust-based quadrotor simulation pipeline. It includes a simulator, controller, and planner, providing a basic framework for simulating quadrotor dynamics and control.
## Dependencies
nalgebra
rand
rerun
## Getting Started
terminal 1
```
cargo install rerun-cli
# terminal 1
rerun
# terminal 2
```
terminal 2
```
cargo run --release
```
## Overview
### Quadrotor Simulator
Simulates dynamics with properties like position, velocity, orientation, and mass. Includes methods for updating dynamics with and without control inputs.
### PID Controller
Controls position and attitude with configurable gains for proportional, integral, and derivative terms.
### Planners
Includes a hover planner and a minimum jerk trajectory planner for generating movement commands.
### Data Logging
Logs simulation data for visualization using rerun.
## License
Licensed under the GPL-3.0 License. See the LICENSE file for details.

## Why call it Peng?
Peng (traditional Chinese: 鵬; simplified Chinese: 鹏; pinyin: péng; Wade–Giles: p'eng) or Dapeng (大鵬) is a giant bird that transforms from a Kun (鯤; 鲲; kūn; k'un) giant fish in Chinese mythology.
Reference: https://en.wikipedia.org/wiki/Peng_(mythology)

0 comments on commit 6344d8e

Please sign in to comment.