Deployed 689529956d with MkDocs version: 1.6.1

This commit is contained in:
nayan
2025-10-07 14:39:19 -04:00
commit 7f5c157d45
61 changed files with 15500 additions and 0 deletions
@@ -0,0 +1,178 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="https://docs.comma.ai/getting-started/what-is-openpilot/" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>What is openpilot? - openpilot docs</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
<link href="../../css/tooltip.css" rel="stylesheet" />
<script>
// Current page data
var mkdocs_page_name = "What is openpilot?";
var mkdocs_page_input_path = "getting-started/what-is-openpilot.md";
var mkdocs_page_url = "/getting-started/what-is-openpilot/";
</script>
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../.." class="icon icon-home"> openpilot docs
</a><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" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="#">What is openpilot?</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#how-do-i-use-it">How do I use it?</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#how-does-it-work">How does it work?</a>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">How-to</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/turn-the-speed-blue/">Turn the speed blue</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/connect-to-comma/">Connect to a comma 3X</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Concepts</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../concepts/logs/">Logs</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../concepts/safety/">Safety</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../concepts/glossary/">Glossary</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Car Porting</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../car-porting/what-is-a-car-port/">What is a car port?</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../car-porting/brand-port/">Porting a car brand</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../car-porting/model-port/">Porting a car model</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Contributing</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/roadmap/">Roadmap</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/commaai/openpilot/blob/master/docs/CONTRIBUTING.md">Contributing Guide →</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Links</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://blog.comma.ai">Blog →</a>
</li>
<li class="toctree-l1"><a class="" href="https://comma.ai/bounties">Bounties →</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/commaai">GitHub →</a>
</li>
<li class="toctree-l1"><a class="" href="https://discord.comma.ai">Discord →</a>
</li>
<li class="toctree-l1"><a class="" href="https://x.com/comma_ai">X →</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../..">openpilot docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item">Getting Started</li>
<li class="breadcrumb-item active">What is openpilot?</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/commaai/openpilot/edit/master/docs/getting-started/what-is-openpilot.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="what-is-openpilot">What is openpilot?</h1>
<p><a href="http://github.com/commaai/openpilot">openpilot</a> 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 <a href="https://github.com/commaai/openpilot/blob/master/docs/CARS.md">supported car makes, models, and model years</a>. In addition, while openpilot is engaged, a camera-based Driver Monitoring (DM) feature alerts distracted and asleep drivers. See more about <a href="https://github.com/commaai/openpilot/blob/master/docs/INTEGRATION.md">the vehicle integration</a> and <a href="https://github.com/commaai/openpilot/blob/master/docs/LIMITATIONS.md">limitations</a>.</p>
<h2 id="how-do-i-use-it">How do I use it?</h2>
<p>openpilot is designed to be used on the comma 3X.</p>
<h2 id="how-does-it-work">How does it work?</h2>
<p>In short, openpilot uses the car's existing APIs for the built-in <a href="https://en.wikipedia.org/wiki/Advanced_driver-assistance_system">ADAS</a> system and simply provides better acceleration, braking, and steering inputs than the stock system.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../../how-to/turn-the-speed-blue/" class="btn btn-neutral float-right" title="Turn the speed blue">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</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>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/commaai/openpilot/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../../how-to/turn-the-speed-blue/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../../js/jquery-3.6.0.min.js"></script>
<script>var base_url = "../..";</script>
<script src="../../js/theme_extra.js"></script>
<script src="../../js/theme.js"></script>
<script src="../../search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>