-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Vehicle Researcher
committed
Jan 19, 2024
0 parents
commit 927be3f
Showing
1,402 changed files
with
406,917 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # openpilot-docs | ||
|
|
||
| These docs are autogenerated from [this folder](https://github.com/commaai/openpilot/tree/master/docs) in the main openpilot repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Sphinx build info version 1 | ||
| # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
| config: ba217bcc7795115b10e5aa2604d6a8ab | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,219 @@ | ||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" data-content_root="./"> | ||
| <head> | ||
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <meta content="openpilot docs" name="description" /> | ||
| <meta content="op, openpilot, docs, documentation" name="keywords" /> | ||
| <meta content="all,follow" name="robots" /> | ||
| <meta content="index,follow,snippet,archive" name="googlebot" /> | ||
| <meta content="en_US" property="og:locale" /> | ||
| <meta content="docs.comma.ai" property="og:site_name" /> | ||
| <meta content="https://docs.comma.ai" property="og:url" /> | ||
| <meta content="openpilot Documentation" property="og:title" /> | ||
| <meta content="website" property="og:type" /> | ||
| <meta content="image/jpeg" property="og:image:type" /> | ||
| <meta content="400" property="og:image:width" /> | ||
| <meta content="https://docs.comma.ai/_static/logo.png" property="og:image" /> | ||
| <meta content="https://docs.comma.ai/_static/logo.png" property="og:image:url" /> | ||
| <meta content="https://docs.comma.ai/_static/logo.png" property="og:image:secure_url" /> | ||
| <meta content="openpilot Documentation" property="og:description" /> | ||
| <meta content="summary_large_image" property="twitter:card" /> | ||
| <meta content="https://docs.comma.ai/_static/logo.png" property="twitter:logo" /> | ||
| <meta content="openpilot Documentation" property="twitter:title" /> | ||
| <meta content="openpilot Documentation" property="twitter:description" /> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>Bounties — openpilot docs 0.9.6 documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" /> | ||
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" /> | ||
|
|
||
|
|
||
| <link rel="shortcut icon" href="_static/favicon.ico"/> | ||
| <link rel="canonical" href="https://docs.comma.ai/BOUNTIES.html" /> | ||
| <!--[if lt IE 9]> | ||
| <script src="_static/js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
|
|
||
| <script src="_static/jquery.js?v=5d32c60e"></script> | ||
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> | ||
| <script src="_static/documentation_options.js?v=564a08b9"></script> | ||
| <script src="_static/doctools.js?v=888ff710"></script> | ||
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> | ||
| <script src="_static/js/theme.js"></script> | ||
| <link rel="index" title="Index" href="genindex.html" /> | ||
| <link rel="search" title="Search" href="search.html" /> | ||
| </head> | ||
|
|
||
| <body class="wy-body-for-nav"> | ||
| <div class="wy-grid-for-nav"> | ||
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||
| <div class="wy-side-scroll"> | ||
| <div class="wy-side-nav-search" style="background: #000000" > | ||
|
|
||
|
|
||
|
|
||
| <a href="index.html" class="icon icon-home"> | ||
| openpilot docs | ||
| <img src="_static/logo.png" class="logo" alt="Logo"/> | ||
| </a> | ||
| <div class="version"> | ||
| 0.9.6 | ||
| </div> | ||
| <div role="search"> | ||
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | ||
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> | ||
| <input type="hidden" name="check_keywords" value="yes" /> | ||
| <input type="hidden" name="area" value="default" /> | ||
| </form> | ||
| </div> | ||
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | ||
| <p class="caption" role="heading"><span class="caption-text">General</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="CARS.html">Supported Cars</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="CARS.html#id1">274 Supported Cars</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="CARS.html#don-t-see-your-car-here">Don’t see your car here?</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">How to contribute</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="INTEGRATION.html">Integration with Stock Features</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="LIMITATIONS.html">Limitations</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="SAFETY.html">Safety</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">Overview</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="overview.html">openpilot</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="overview.html#cereal">cereal</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="overview.html#models">models</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="overview.html#opendbc">opendbc</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="overview.html#panda">panda</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="overview.html#rednose">rednose</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="overview.html#tools">tools</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">Python API</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="modules.html">openpilot</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">C/C++ API</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="c_docs.html">openpilot</a></li> | ||
| </ul> | ||
|
|
||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #000000" > | ||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="index.html">openpilot docs</a> | ||
| </nav> | ||
|
|
||
| <div class="wy-nav-content"> | ||
| <div class="rst-content"> | ||
| <div role="navigation" aria-label="Page navigation"> | ||
| <ul class="wy-breadcrumbs"> | ||
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> | ||
| <li class="breadcrumb-item active">Bounties</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| <a href="_sources/BOUNTIES.md.txt" rel="nofollow"> View page source</a> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div itemprop="articleBody"> | ||
|
|
||
| <section id="bounties"> | ||
| <h1><a class="reference external" href="https://github.com/orgs/commaai/projects/26/views/1">Bounties</a><a class="headerlink" href="#bounties" title="Link to this heading"></a></h1> | ||
| <p>Get paid to improve openpilot!</p> | ||
| <section id="rules"> | ||
| <h2>Rules<a class="headerlink" href="#rules" title="Link to this heading"></a></h2> | ||
| <ul class="simple"> | ||
| <li><p>code must be merged into openpilot master</p></li> | ||
| <li><p>bounty eligibility is solely at our discretion</p></li> | ||
| <li><p>once you open a PR, the bounty is locked to you until you stop working on it</p></li> | ||
| <li><p>open a ticket at <a class="reference external" href="https://comma.ai/support/shop-order">comma.ai/support</a> with links to your PRs to claim</p></li> | ||
| <li><p>get an extra 20% if you redeem your bounty in <a class="reference external" href="https://comma.ai/shop">comma shop</a> credit (including refunds on previous orders)</p></li> | ||
| </ul> | ||
| <p>New bounties can be proposed in the <a class="reference external" href="https://discord.com/channels/469524606043160576/1183173332531687454"><strong>#contributing</strong></a> channel in Discord.</p> | ||
| </section> | ||
| <section id="issue-bounties"> | ||
| <h2>Issue bounties<a class="headerlink" href="#issue-bounties" title="Link to this heading"></a></h2> | ||
| <p>We’ve tagged bounty-eligible issues across openpilot and the rest of our repos; check out all the open ones <a class="reference external" href="https://github.com/orgs/commaai/projects/26/views/1">here</a>. These bounties roughly work out like this:</p> | ||
| <ul class="simple"> | ||
| <li><p><strong>$100</strong> - a few hours of work for an experienced openpilot developer; a good intro for someone new to openpilot</p></li> | ||
| <li><p><strong>$300</strong> - a day of work for an experienced openpilot developer</p></li> | ||
| <li><p><strong>$500</strong> - a few days of work for an experienced openpilot developer</p></li> | ||
| <li><p><strong>$1k+</strong> - a week or two of work (could be less for the right person)</p></li> | ||
| </ul> | ||
| </section> | ||
| <section id="car-bounties"> | ||
| <h2>Car bounties<a class="headerlink" href="#car-bounties" title="Link to this heading"></a></h2> | ||
| <p>The car bounties only apply to cars that have a path to ship in openpilot release, which excludes unsupportable cars (e.g. Fords with a steering lockout) or cars that require extra hardware (Honda Accord with serial steering).</p> | ||
| <section id="brand-or-platform-port-2000"> | ||
| <h3>Brand or platform port - $2000<a class="headerlink" href="#brand-or-platform-port-2000" title="Link to this heading"></a></h3> | ||
| <p>Example PR: <a class="reference external" href="https://github.com/commaai/openpilot/pull/23331">commaai/openpilot#23331</a></p> | ||
| <p>This is for adding support for an entirely new brand or a substantially new ADAS platform within a brand (e.g. the Volkswagen PQ platform).</p> | ||
| </section> | ||
| <section id="model-port-250"> | ||
| <h3>Model port - $250<a class="headerlink" href="#model-port-250" title="Link to this heading"></a></h3> | ||
| <p>Example PR: <a class="reference external" href="https://github.com/commaai/openpilot/pull/30245">commaai/openpilot#30245</a></p> | ||
| <p>This is for porting a new car model that runs on a platform openpilot already supports. | ||
| In the average case, this is a few hours of work for an experienced software developer.</p> | ||
| <p>This bounty also covers getting openpilot supported on a previously unsupported trim of an already supported car, e.g. the Chevy Bolt without ACC.</p> | ||
| </section> | ||
| <section id="reverse-engineering-a-new-actuation-message-300"> | ||
| <h3>Reverse Engineering a new Actuation Message - $300<a class="headerlink" href="#reverse-engineering-a-new-actuation-message-300" title="Link to this heading"></a></h3> | ||
| <p>This is for cars that are already supported, and it has three components:</p> | ||
| <ul class="simple"> | ||
| <li><p>reverse a new steering, adaptive cruise, or AEB message</p></li> | ||
| <li><p>merge the DBC definitions to <a class="reference external" href="http://github.com/commaai/opendbc">opendbc</a></p></li> | ||
| <li><p>merge the openpilot code to use it and post a demo route</p></li> | ||
| </ul> | ||
| <p>The control doesn’t have to be perfect, but it should generally do what it’s supposed to do.</p> | ||
| </section> | ||
| <section id="specific-cars"> | ||
| <h3>Specific Cars<a class="headerlink" href="#specific-cars" title="Link to this heading"></a></h3> | ||
| <section id="rivian-r1t-or-r1s-3000"> | ||
| <h4>Rivian R1T or R1S - $3000<a class="headerlink" href="#rivian-r1t-or-r1s-3000" title="Link to this heading"></a></h4> | ||
| <p>Get a Rivian driving with openpilot. | ||
| Requires a merged port with lateral control and at least a POC of longitudinal control.</p> | ||
| </section> | ||
| <section id="toyota-secoc-5000"> | ||
| <h4>Toyota SecOc - $5000<a class="headerlink" href="#toyota-secoc-5000" title="Link to this heading"></a></h4> | ||
| <p>We’re contributing $5k to the <a class="reference external" href="https://github.com/commaai/openpilot/discussions/19932">community-organized bounty</a>.</p> | ||
| </section> | ||
| <section id="chevy-bolt-with-supercruise-2500"> | ||
| <h4>Chevy Bolt with SuperCruise - $2500<a class="headerlink" href="#chevy-bolt-with-supercruise-2500" title="Link to this heading"></a></h4> | ||
| <p>The Bolt is already supported on the trim with standard ACC. Get openpilot working on the trim with SuperCruise. It must be a normal install: no extra pandas or other hardware, no ECU reflashes, etc. The full bounty is for a port with lateral and longitudinal control. $1500 of the bounty can be claimed with a lateral-only port.</p> | ||
| </section> | ||
| </section> | ||
| </section> | ||
| </section> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <footer> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p>© Copyright 2021, comma.ai.</p> | ||
| </div> | ||
|
|
||
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a | ||
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> | ||
| provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
|
|
||
|
|
||
| </footer> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| <script> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.