253 lines
12 KiB
Markdown
253 lines
12 KiB
Markdown
<div align="center" style="text-align: center;">
|
||
|
||
<h1>openpilot</h1>
|
||
|
||
<p>
|
||
<b>openpilot is an operating system for robotics.</b>
|
||
<br>
|
||
Currently, it upgrades the driver assistance system in 300+ supported cars.
|
||
</p>
|
||
|
||
<h3>
|
||
<a href="https://docs.comma.ai">Docs</a>
|
||
<span> · </span>
|
||
<a href="https://docs.comma.ai/contributing/roadmap/">Roadmap</a>
|
||
<span> · </span>
|
||
<a href="https://github.com/commaai/openpilot/blob/master/docs/CONTRIBUTING.md">Contribute</a>
|
||
<span> · </span>
|
||
<a href="https://discord.comma.ai">Community</a>
|
||
<span> · </span>
|
||
<a href="https://comma.ai/shop">Try it on a comma 3X</a>
|
||
</h3>
|
||
|
||
Quick start: `bash <(curl -fsSL openpilot.comma.ai)`
|
||
|
||
[](https://github.com/commaai/openpilot/actions/workflows/selfdrive_tests.yaml)
|
||
[](LICENSE)
|
||
[](https://x.com/comma_ai)
|
||
[](https://discord.comma.ai)
|
||
|
||
</div>
|
||
|
||
<table>
|
||
<tr>
|
||
<td><a href="https://youtu.be/NmBfgOanCyk" title="Video By Greer Viau"><img src="https://github.com/commaai/openpilot/assets/8762862/2f7112ae-f748-4f39-b617-fabd689c3772"></a></td>
|
||
<td><a href="https://youtu.be/VHKyqZ7t8Gw" title="Video By Logan LeGrand"><img src="https://github.com/commaai/openpilot/assets/8762862/92351544-2833-40d7-9e0b-7ef7ae37ec4c"></a></td>
|
||
<td><a href="https://youtu.be/SUIZYzxtMQs" title="A drive to Taco Bell"><img src="https://github.com/commaai/openpilot/assets/8762862/05ceefc5-2628-439c-a9b2-89ce77dc6f63"></a></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
Using openpilot in a car
|
||
------
|
||
|
||
To use openpilot in a car, you need four things:
|
||
1. **Supported Device:** a comma 3/3X, available at [comma.ai/shop](https://comma.ai/shop/comma-3x).
|
||
2. **Software:** The setup procedure for the comma 3/3X allows users to enter a URL for custom software. Use the URL `openpilot.comma.ai` to install the release version.
|
||
3. **Supported Car:** Ensure that you have one of [the 275+ supported cars](docs/CARS.md).
|
||
4. **Car Harness:** You will also need a [car harness](https://comma.ai/shop/car-harness) to connect your comma 3/3X to your car.
|
||
|
||
We have detailed instructions for [how to install the harness and device in a car](https://comma.ai/setup). Note that it's possible to run openpilot on [other hardware](https://blog.comma.ai/self-driving-car-for-free/), although it's not plug-and-play.
|
||
|
||
------
|
||
|
||
<div align="center" style="text-align: center;">
|
||
|
||
<h1>FrogPilot 🐸</h1>
|
||
|
||
[](https://deepwiki.com/FrogAi/FrogPilot)
|
||
[](https://discord.frogpilot.download)
|
||
[](https://github.com/FrogAi/FrogPilot/releases/latest)
|
||
[](https://frogpilot.wiki.gg/)
|
||
|
||
</div>
|
||
|
||
------
|
||
|
||
**FrogPilot** is a custom frog-themed fork of openpilot that embraces a collaborative, community-driven approach to push the project forward. It delivers bleeding-edge features and experimental improvements far ahead of official releases. As an unofficial and highly experimental version of openpilot, **FrogPilot** should always be used with caution!
|
||
|
||
openpilot vs **FrogPilot**
|
||
------
|
||
|
||
#### Community
|
||
| Feature | openpilot | **FrogPilot** |
|
||
|---------|:---------:|:---------:|
|
||
| A Welcoming Community | ❌ | ✅ |
|
||
| Erich / Primary Moderators / 🦇 | ✅ | ❌ |
|
||
|
||
#### Core Features
|
||
| Feature | openpilot | **FrogPilot** |
|
||
|---------|:---------:|:---------:|
|
||
| Always On Lateral (Steering) | ❌ | ✅ |
|
||
| Blind Spot Integration | ✅ | ✅ |
|
||
| Conditional Experimental Mode | ❌ | ✅ |
|
||
| Custom Themes | ❌ | ✅ |
|
||
| Driver Monitoring | ✅ | ✅ |
|
||
| Driving Model Selector | ❌ | ✅ |
|
||
| Holiday Themes | ❌ | ✅ |
|
||
| Speed Limit Support | ❌ | ✅ |
|
||
| Weather Detection | ❌ | ✅ |
|
||
|
||
#### Device & Hardware
|
||
| Feature | openpilot | **FrogPilot** |
|
||
|---------|:---------:|:---------:|
|
||
| Advanced Volume Controller | ❌ | ✅ |
|
||
| Automatic Version Backups | ❌ | ✅ |
|
||
| C3 Support | ❌ | ✅ |
|
||
| comma Pedal Support | ❌ | ✅ |
|
||
| High Quality Recordings | ❌ | ✅ |
|
||
| SDSU Support | ❌ | ✅ |
|
||
| ZSS Support | ❌ | ✅ |
|
||
|
||
#### Gas/Brake
|
||
| Feature | openpilot | **FrogPilot** |
|
||
|---------|:---------:|:---------:|
|
||
| Adaptive Cruise Control (ACC) | ✅ | ✅ |
|
||
| Advanced Live Tuning | ❌ | ✅ |
|
||
| Custom Following Distances | ❌ | ✅ |
|
||
| Faster Human-Like Acceleration | ❌ | ✅ |
|
||
| Human-Like Speed Control in Curves | ❌ | ✅ |
|
||
| Smoother Human-Like Braking | ❌ | ✅ |
|
||
|
||
#### Steering
|
||
| Feature | openpilot | **FrogPilot** |
|
||
|---------|:---------:|:---------:|
|
||
| Advanced Live Tuning | ❌ | ✅ |
|
||
| Automatic Lane Changes | ❌ | ✅ |
|
||
| Increased Steering Torque* | ❌ | ✅ |
|
||
| Lane Centering (LKAS) | ✅ | ✅ |
|
||
| Lane Change Assist | ✅ | ✅ |
|
||
|
||
*Select vehicles only
|
||
|
||
And much much more!
|
||
|
||
🌟 Highlight Features
|
||
------
|
||
|
||
### 🚗 Always On Lateral (AOL)
|
||
|
||
With **"Always On Lateral"**, lane-centering stays active whenever cruise control is on, even when you press the accelerator or brake. This means steering assist won't cut out during manual speed adjustments giving you continuous support through curves, traffic, or mountain roads!
|
||
|
||
---
|
||
|
||
### 🧠 Conditional Experimental Mode (CEM)
|
||
|
||
**["Experimental Mode"](https://blog.comma.ai/090release/#experimental-mode)** lets openpilot drive at the speed it thinks a human would to allow slowing for curves, stopping at stoplights/stop signs, and adapting to traffic. This makes it powerful in complex scenarios, but it's still, well, "experimental" and less predictable than **"Chill Mode"**. But **"Conditional Experimental Mode"** gives you the best of both worlds by automatically switching between **"Chill Mode"** for steady cruising and **"Experimental Mode"** for more advanced situations to help fully automate your driving experience!
|
||
|
||
**"Conditional Experimental Mode"** switches into **"Experimental Mode"** when conditions like these are met:
|
||
- Approaching curves and turns
|
||
- Detecting slower or stopped lead vehicles
|
||
- Driving below a set speed
|
||
- Predicting an upcoming stop (e.g. stoplight or stop sign)
|
||
|
||
Once conditions clear it returns to **"Chill Mode"** for stability and predictability.
|
||
|
||
**Note: Stay attentive as "Experimental Mode" is an alpha feature and mistakes are expected!**
|
||
|
||
---
|
||
|
||
### 🎭 Driving Personalities
|
||
|
||
With **"Driving Personalities"**, you choose how the vehicle behaves with four adjustable profiles:
|
||
|
||
- **Traffic:** Catered towards stop-and-go traffic by minimizing gaps and delays
|
||
- **Aggressive:** Aimed to provide tighter following distances and quicker reactions
|
||
- **Standard:** Useful for a balanced, all-purpose driving
|
||
- **Relaxed:** A smoother driving experience with larger following distance gaps
|
||
|
||
Each profile can be fine-tuned to change the desired following distance, acceleration, and braking style letting you shape **FrogPilot**'s behavior to match your own driving preferences! Profiles can be switched instantly using the following distance button on the steering wheel, while **"Traffic Mode"** can be enabled by simply holding down the following distance button.
|
||
|
||
---
|
||
|
||
### 📏 Speed Limit Controller (SLC)
|
||
|
||
With **"Speed Limit Controller"**, **FrogPilot** automatically adapts to the road's posted speed using information from downloaded **["OpenStreetMap"](https://www.openstreetmap.org)** maps, online **["Mapbox"](https://www.mapbox.com)** data, and the vehicle's dashboard (if supported).
|
||
|
||
Offsets let you fine-tune how closely **FrogPilot** follows posted limits across different speed ranges allowing you to cruise slightly above or below for a more natural driving experience. If no speed limit is available, you can choose whether **FrogPilot** drives at the set speed, falls back to the last known speed limit, or uses **"Experimental Mode"** to estimate one with the driving model.
|
||
|
||
Maps can be downloaded directly in settings and updated automatically on a schedule ensuring your device always has the latest speed limits!
|
||
|
||
**Note: Speed limits are only as accurate as the available speed limit data. Always stay attentive and adjust your speed when necessary!**
|
||
|
||
---
|
||
|
||
### 🎨 Themes
|
||
|
||
With **"Themes"**, you can personalize **FrogPilot**'s driving screen to make it uniquely yours! Choose from:
|
||
|
||
- **Color Schemes**
|
||
- **Icon Packs**
|
||
- **Sound Packs**
|
||
- **Turn Signal Animations**
|
||
- **Steering Wheel Icons**
|
||
|
||
Enjoy pre-existing **FrogPilot** and seasonal holiday themes, or you can create your own with the **"Theme Maker"** and even share them with the community! For extra fun, enable features like the Mario Kart–style **"Rainbow Path"** or **"Random Events"** that add playful visual effects while you drive!
|
||
|
||
---
|
||
|
||
And lots more! From safety enhancements to personalization options, **FrogPilot** continues to evolve with features that put you in control. Check it out today for yourself!
|
||
|
||
---
|
||
|
||
🔧 Branches
|
||
------
|
||
| Branch | Install URL | Description | Recommended For |
|
||
|----------------------------|---------------------------|--------------------------------------------------------|--------------------------|
|
||
| FrogPilot | frogpilot.download | The main release branch. | Everyone |
|
||
| FrogPilot‑Staging | staging.frogpilot.download| Beta branch with upcoming features. Expect bugs! | Early Adopters |
|
||
| FrogPilot‑Testing | testing.frogpilot.download| Alpha branch with bleeding-edge features. Breaks often!| Advanced Testers |
|
||
| FrogPilot‑Development| No :) | Active development branch. Don't use! | **FrogPilot** Developers|
|
||
| MAKE‑PRS‑HERE | No :) | Workspace for pull requests. Don't use! | Contributors |
|
||
|
||
🧰 How to Install
|
||
------
|
||
|
||
The easiest way to install **FrogPilot** is by entering this URL on the installation screen:
|
||
|
||
```
|
||
frogpilot.download
|
||
```
|
||
|
||
**DO NOT** install the **FrogPilot-Development** branch. I'm constantly breaking things on there, so unless you don't want to use **FrogPilot**, **NEVER** install it!
|
||
|
||
|
||
|
||
🐞 Bug Reports / Feature Requests
|
||
------
|
||
|
||
If you run into bugs, issues, or have ideas for new features, please post about it on the **[FrogPilot Discord](https://discord.gg/frogpilot)**! Feedback helps improve **FrogPilot** and create a better experience for everyone!
|
||
|
||
To report a bug, please post it in [**#bug-reports**](https://discord.com/channels/1137853399715549214/1162100167110053888).
|
||
To request a feature, please post it in [**#feature-requests**](https://discord.com/channels/1137853399715549214/1160318669839147259).
|
||
|
||
Please include as much detail as possible! Photos, videos, log files, or anything that can help explain the issue or idea are very helpful!
|
||
|
||
I'll do my best to respond promptly, but not every request can be addressed right away. Your feedback is always appreciated and helps make **FrogPilot** the best it can be!
|
||
|
||
📋 Credits
|
||
------
|
||
|
||
* [Aidenir](https://github.com/Aidenir)
|
||
* [AlexandreSato](https://github.com/AlexandreSato)
|
||
* [cfranyota](https://github.com/cfranyota)
|
||
* [cydia2020](https://github.com/cydia2020)
|
||
* [dragonpilot-community](https://github.com/dragonpilot-community)
|
||
* [ErichMoraga](https://github.com/ErichMoraga)
|
||
* [garrettpall](https://github.com/garrettpall)
|
||
* [jakethesnake420](https://github.com/jakethesnake420)
|
||
* [jyoung8607](https://github.com/jyoung8607)
|
||
* [mike8643](https://github.com/mike8643)
|
||
* [neokii](https://github.com/neokii)
|
||
* [OPGM](https://github.com/opgm)
|
||
* [OPKR](https://github.com/openpilotkr)
|
||
* [pfeiferj](https://github.com/pfeiferj)
|
||
* [realfast](https://github.com/realfast)
|
||
* [syncword](https://github.com/syncword)
|
||
* [twilsonco](https://github.com/twilsonco)
|
||
|
||
Star History
|
||
------
|
||
|
||
[](https://www.star-history.com/#FrogAi/FrogPilot&Date)
|