156 lines
6.4 KiB
Markdown
156 lines
6.4 KiB
Markdown
[](https://comma.ai/shop/comma-3x)
|
||
|
||
What is openpilot?
|
||
------
|
||
|
||
[openpilot](http://github.com/commaai/openpilot) is an open source driver assistance system. Currently, openpilot performs the functions of Adaptive Cruise Control (ACC), Automated Lane Centering (ALC), Forward Collision Warning (FCW), and Lane Departure Warning (LDW) for a growing variety of [supported car makes, models, and model years](docs/CARS.md). In addition, while openpilot is engaged, a camera-based Driver Monitoring (DM) feature alerts distracted and asleep drivers. See more about [the vehicle integration](docs/INTEGRATION.md) and [limitations](docs/LIMITATIONS.md).
|
||
|
||
<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>
|
||
|
||
What is FrogPilot? 🐸
|
||
------
|
||
|
||
FrogPilot is a fully open-sourced fork of openpilot, featuring clear and concise commits striving to be a resource for the openpilot developer community. It thrives on contributions from both users and developers, focusing on a collaborative, community-led approach to deliver an advanced openpilot experience for everyone!
|
||
|
||
------
|
||
FrogPilot was last updated on:
|
||
|
||
**July 1st, 2024**
|
||
|
||
Features
|
||
------
|
||
|
||
FrogPilot offers a wide range of customizable features that are easily toggled on or off to suit your preferences. Whether you want a completely stock openpilot experience, or want to add some fun and personal touches, FrogPilot has you covered! Some of the features include:
|
||
|
||
------
|
||
|
||
<details>
|
||
<summary>Device</summary>
|
||
<blockquote>
|
||
</blockquote>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Network</summary>
|
||
<blockquote>
|
||
</blockquote>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Toggles</summary>
|
||
<blockquote>
|
||
</blockquote>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Software</summary>
|
||
<blockquote>
|
||
</blockquote>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Controls</summary>
|
||
<blockquote>
|
||
<details>
|
||
<summary>Always On Lateral</summary>
|
||
<p>Maintain openpilot lateral control when the brake or gas pedals are used. Deactivation occurs only through the 'Cruise Control' button.</p>
|
||
<ul>
|
||
<li><strong>Enable On Cruise Main:</strong> Enable "Always On Lateral" by clicking your 'Cruise Control' button without requiring openpilot to be enabled first.</li>
|
||
<li><strong>Pause On Brake:</strong> Pause "Always On Lateral" when the brake pedal is being pressed below the set speed.</li>
|
||
<li><strong>Hide the Status Bar:</strong> Don't use the status bar for "Always On Lateral".</li>
|
||
</ul>
|
||
</details>
|
||
</blockquote>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Navigation</summary>
|
||
<blockquote>
|
||
</blockquote>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Vehicles</summary>
|
||
<blockquote>
|
||
</blockquote>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Visuals</summary>
|
||
<blockquote>
|
||
</blockquote>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Other</summary>
|
||
<blockquote>
|
||
</blockquote>
|
||
</details>
|
||
|
||
How to Install
|
||
------
|
||
|
||
Easiest way to install FrogPilot is via this URL at 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 openpilot, NEVER install it!
|
||
|
||
|
||
|
||
Bug reports / Feature Requests
|
||
------
|
||
|
||
If you encounter any issues or bugs while using FrogPilot, or if you have any suggestions for new features or improvements, please don't hesitate to post about it on the Discord! I'm always looking for ways to improve the fork and provide a better experience for everyone!
|
||
|
||
To report a bug or request a new feature, make a post in the #bug-reports or #feature-requests channel respectively on the FrogPilot Discord. Please provide as much detail as possible about the issue you're experiencing or the feature you'd like to see added. Photos, videos, log files, or other relevant information are very helpful!
|
||
|
||
I will do my best to respond to bug reports and feature requests in a timely manner, but please understand that I may not be able to address every request immediately. Your feedback and suggestions are valuable, and I appreciate your help in making FrogPilot the best it can be!
|
||
|
||
Discord
|
||
------
|
||
|
||
[Join the FrogPilot Community Discord!](https://discord.gg/frogpilot)
|
||
|
||
Credits
|
||
------
|
||
|
||
* [AlexandreSato](https://github.com/AlexandreSato)
|
||
* [Crwusiz](https://github.com/crwusiz)
|
||
* [DragonPilot](https://github.com/dragonpilot-community)
|
||
* [ErichMoraga](https://github.com/ErichMoraga)
|
||
* [Garrettpall](https://github.com/garrettpall)
|
||
* [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)
|
||
* [ServerDummy](https://github.com/ServerDummy)
|
||
* [Twilsonco](https://github.com/twilsonco)
|
||
|
||
Licensing
|
||
------
|
||
|
||
openpilot is released under the MIT license. Some parts of the software are released under other licenses as specified.
|
||
|
||
Any user of this software shall indemnify and hold harmless Comma.ai, Inc. and its directors, officers, employees, agents, stockholders, affiliates, subcontractors and customers from and against all allegations, claims, actions, suits, demands, damages, liabilities, obligations, losses, settlements, judgments, costs and expenses (including without limitation attorneys’ fees and costs) which arise out of, relate to or result from any use of this software by user.
|
||
|
||
**THIS IS ALPHA QUALITY SOFTWARE FOR RESEARCH PURPOSES ONLY. THIS IS NOT A PRODUCT.
|
||
YOU ARE RESPONSIBLE FOR COMPLYING WITH LOCAL LAWS AND REGULATIONS.
|
||
NO WARRANTY EXPRESSED OR IMPLIED.**
|
||
|
||
---
|
||
|
||
<img src="https://d1qb2nb5cznatu.cloudfront.net/startups/i/1061157-bc7e9bf3b246ece7322e6ffe653f6af8-medium_jpg.jpg?buster=1458363130" width="75"></img> <img src="https://cdn-images-1.medium.com/max/1600/1*C87EjxGeMPrkTuVRVWVg4w.png" width="225"></img>
|
||
|
||
|
||
[](https://codecov.io/gh/commaai/openpilot)
|