openpilot README

The project's README from github.com/commaai/openpilot. As one markdown file: README.md.

openpilot

openpilot is an operating system for robotics.
Currently, it upgrades the driver assistance system in 300+ supported cars.

Docs · Roadmap · Contribute · Community · Try it on a comma four

Quick start: bash <(curl -fsSL openpilot.comma.ai)

openpilot tests License: MIT X Follow Discord

Using openpilot in a car

To use openpilot in a car, you need four things:

  1. Supported Device: a comma four, available at comma.ai/shop/comma-four.
  2. Software: The setup procedure for the comma four 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 300+ supported cars.
  4. Car Harness: You will also need a car harness to connect your comma four to your car.

We have detailed instructions for how to install the harness and device in a car. Note that it's possible to run openpilot on other hardware, although it's not plug-and-play.

Branches

Running master and other branches directly is supported, but it's recommended to run one of the following prebuilt branches:

comma four branch comma 3X branch URL description
release-mici release-tizi openpilot.comma.ai This is openpilot's release branch.
release-mici-staging release-tizi-staging openpilot-test.comma.ai This is the staging branch for releases. Use it to get new releases slightly early.
nightly nightly openpilot-nightly.comma.ai This is the bleeding edge development branch. Do not expect this to be stable.
nightly-dev nightly-dev installer.comma.ai/commaai/nightly-dev Same as nightly, but includes experimental development features for some cars.

For chestnut, use the following installer URLs:

branch URL description
release-chestnut installer.comma.ai/commaai/release-chestnut This is openpilot's release branch.
release-chestnut-staging installer.comma.ai/commaai/release-chestnut-staging This is the staging branch for releases. Use it to get new releases slightly early.
nightly-chestnut installer.comma.ai/commaai/nightly-chestnut This is the bleeding edge development branch. Do not expect this to be stable.
nightly-chestnut-dev installer.comma.ai/commaai/nightly-chestnut-dev Same as nightly, but includes experimental development features for some cars.

To start developing openpilot

openpilot is developed by comma and by users like you. We welcome both pull requests and issues on GitHub.

Want to get paid to work on openpilot? comma is hiring and offers lots of bounties for external contributors.

Safety and Testing

MIT Licensed

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.

User Data and comma Account

By default, openpilot uploads driving data to our servers. You can also access your data through comma connect. We use your data to train better models and improve openpilot for everyone.

openpilot is open source software, and users can disable data collection if they wish.

openpilot logs the road-facing cameras, CAN, GPS, IMU, magnetometer, thermal sensors, crashes, and operating system logs. The driver-facing camera and microphone are only logged if you explicitly opt-in in settings.

By using openpilot, you agree to our Privacy Policy. You understand that use of this software or its related services will generate certain types of user data, which may be logged and stored at the sole discretion of comma. By accepting this agreement, you grant an irrevocable, perpetual, worldwide right to comma for the use of this data.

openpilot (commaai/openpilot)

Searching Database…

63.9K ·GitHub
What is this?openpilot is an operating system for robotics that currently powers the driver assistance system in over 300 supported cars.
Is this an app I install on my phone, or dedicated hardware?It runs on a dedicated piece of hardware called a comma device (the comma four), mounted in the car, not on your phone.
How do I get openpilot running in my car?Buy a comma four, flash it with the openpilot.comma.ai installer URL to get the release build, confirm your car is on the 300+ supported list, and install a car harness to connect the device to your car's wiring.
What exactly do I need before I can use it?A comma four device, a supported car, and a car harness to wire the device into that car's systems — all four pieces are required together.
Is this a finished, production-ready product?No — the README explicitly states it is alpha quality research software, not a product, and users are responsible for following local laws when using it.
What happens to the data it collects from my driving?By default openpilot uploads driving data (road-facing cameras, CAN, GPS, IMU, magnetometer, thermal sensors, crashes, OS logs) to comma's servers to train and improve the models; the driver-facing camera and microphone are only logged if you opt in, and you can disable data collection since it's open source.
Which branch should I actually run?Use the release branch (release-mici for comma four, release-tizi for comma 3X) for stability, nightly for bleeding-edge development builds, or nightly-dev if you want experimental features for some cars — all are prebuilt and installable via URL.
Why is safety-critical code kept separate in a component called panda?panda enforces the safety model in C with its own software- and hardware-in-the-loop tests, isolating the critical braking/steering safety logic from the rest of openpilot's Python codebase.
Can I run openpilot on hardware other than comma's own device?Yes, but the README notes it isn't plug-and-play like the official comma four — you'd need to handle the setup yourself.
How much testing does the safety model actually get?openpilot follows ISO26262 guidelines, runs software-in-the-loop tests on every commit, and comma internally replays routes continuously on a closet of 10 comma devices via a hardware-in-the-loop Jenkins suite.
Creator
commaai
Size
3 GB
Stars
63.9K
Age
9y
Commits · 90 Days