openpilot is an open source driver assistance system. openpilot performs the functions of Automated Lane Centering and Adaptive Cruise Control for over 150 supported car makes and models.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Adeeb Shihadeh 2cff05be43
UI: exit gracefully (#25388)
24 hours ago
.github CI: don't run badges job on forks (#25381) 1 day ago
cereal@fbd45de6e6 Quectel unix timestamp (#25329) 7 days ago
common Cleanup calibration code (#25119) 7 days ago
docs GM: add OBD-II harness to all GMs (#25356) 3 days ago
laika_repo@c8bc1fa01b Qcom use laika timestamp (#25344) 6 days ago
opendbc@24acbb7c2b Subaru: Add ES_Distance Cruise_Soft_Disable (#24474) 1 week ago
panda@89989abca5 Hyundai: support Kona Electric 2022 (camera SCC) (#23517) 6 days ago
pyextra longitudinal MPC: use reset() function instead of recreating the solver in (#24091) 4 months ago
rednose_repo@3b6bd703b7 Fix master-ci dirty working tree + CI test (#25087) 1 month ago
release multilanguage: compile QM in scons (#25217) 3 weeks ago
scripts Move selfdrive/hardware/ to system/ (#24725) 2 months ago
selfdrive UI: exit gracefully (#25388) 24 hours ago
site_scons/site_tools Add scanner for Cython dependencies (#19722) 2 years ago
system Update model replay commit for calib change (#25357) 5 days ago
third_party multilanguage: compile QM in scons (#25217) 3 weeks ago
tools remove old tools script 1 day ago
.clang-tidy setup clang tidy (#19533) 2 years ago
.dir-locals.el root directory hidden files 3 years ago
.dockerignore sim: update CARLA to 0.9.12 (#22497) 10 months ago
.editorconfig Write orientation & transform in C++ (#1637) 2 years ago
.gitattributes cleanup .gitattributes (#23503) 7 months ago
.gitignore multilanguage: compile QM in scons (#25217) 3 weeks ago
.gitmodules Remove apks submodule (#1711) 2 years ago
.lfsconfig lfs: easier to use config (#23490) 7 months ago
.pre-commit-config.yaml run pre-commit in release CI (#25158) 4 weeks ago
.pylintrc Move a bunch of stuff to system/ part 3 (#24829) 2 months ago
.python-version update to python 3.8.10 (#22551) 10 months ago
Dockerfile.openpilot misc jenkins fixups (#24840) 2 months ago
Dockerfile.openpilot_base CI: add SSH for pushing branches 3 months ago
Dockerfile.openpilot_base_cl Fix onnx model replay (#24702) 2 months ago
Jenkinsfile jenkins: disable power draw test for now 4 days ago
LICENSE root directory non hidden files 3 years ago
Pipfile add pandas and tabulate packages (#25076) 1 month ago
Pipfile.lock add pandas and tabulate packages (#25076) 1 month ago
README.md docs: fix Table of Contents link to "in a car" section (#25225) 3 weeks ago
RELEASES.md Hyundai: support Kona Electric 2022 (camera SCC) (#23517) 6 days ago
SConstruct navd: add back VisionIPC map renderer (#25212) 3 weeks ago
codecov.yml disable codecov comment 2 years ago
laika root directory non hidden files 3 years ago
launch_chffrplus.sh Move selfdrive/hardware/ to system/ (#24725) 2 months ago
launch_env.sh AGNOS 5.2 (#25011) 1 month ago
launch_openpilot.sh root directory non hidden files 3 years ago
lgtm.yml phonelibs -> third_party (#22477) 10 months ago
mypy.ini enable numpy mypy typing (#24387) 3 months ago
rednose Rednose (#1503) 2 years ago
update_requirements.sh fix pre-commit install when subdirectories don't have a config 5 months ago

README.md

Table of Contents


What is openpilot?

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. In addition, while openpilot is engaged, a camera based Driver Monitoring (DM) feature alerts distracted and asleep drivers. See more about the vehicle integration and limitations.

Running on a dedicated device in a car

To use openpilot in a car, you need four things

  • A supported device to run this software: a comma three.
  • This software. The setup procedure of the comma three allows the user to enter a url for custom software. The url, openpilot.comma.ai will install the release version of openpilot. To install openpilot master, you can use installer.comma.ai/commaai/master, and replacing commaai with another github username can install a fork.
  • One of the 150+ supported cars. We support Honda, Toyota, Hyundai, Nissan, Kia, Chrysler, Lexus, Acura, Audi, VW, and more. If your car is not supported, but has adaptive cruise control and lane keeping assist, it's likely able to run openpilot.
  • A car harness to connect to your car.

We have detailed instructions for how to mount the device in a car.

Running on PC

All of openpilot's services can run as normal on a PC, even without special hardware or a car. To develop or experiment with openpilot you can run openpilot on recorded or simulated data.

With openpilot's tools you can plot logs, replay drives and watch the full-res camera streams. See the tools README for more information.

You can also run openpilot in simulation with the CARLA simulator. This allows openpilot to drive around a virtual car on your Ubuntu machine. The whole setup should only take a few minutes, but does require a decent GPU.

A PC running openpilot can also control your vehicle if it is connected to a a webcam, a black panda, and a harness.

Community and Contributing

openpilot is developed by comma and by users like you. We welcome both pull requests and issues on GitHub. Bug fixes and new car ports are encouraged. Check out the contributing docs.

Documentation related to openpilot development can be found on docs.comma.ai. Information about running openpilot (e.g. FAQ, fingerprinting, troubleshooting, custom forks, community hardware) should go on the wiki.

You can add support for your car by following guides we have written for Brand and Model ports. Generally, a car with adaptive cruise control and lane keep assist is a good candidate. Join our Discord to discuss car ports: most car makes have a dedicated channel.

Want to get paid to work on openpilot? comma is hiring.

And follow us on Twitter.

User Data and comma Account

By default, openpilot uploads the 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: the user is free to disable data collection if they wish to do so.

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

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.

Safety and Testing

  • openpilot observes ISO26262 guidelines, see SAFETY.md for more details.
  • openpilot has software in the loop tests that run on every commit.
  • The code enforcing the safety model lives in panda and is written in C, see code rigor for more details.
  • panda has software in the loop safety tests.
  • Internally, we have a hardware in the loop Jenkins test suite that builds and unit tests the various processes.
  • panda has additional hardware in the loop tests.
  • We run the latest openpilot in a testing closet containing 10 comma devices continuously replaying routes.

Directory Structure

.
├── cereal              # The messaging spec and libs used for all logs
├── common              # Library like functionality we've developed here
├── docs                # Documentation
├── opendbc             # Files showing how to interpret data from cars
├── panda               # Code used to communicate on CAN
├── third_party         # External libraries
├── pyextra             # Extra python packages
└── system              # Generic services
    ├── camerad         # Driver to capture images from the camera sensors
    ├── clocksd         # Broadcasts current time
    ├── hardware        # Hardware abstraction classes
    ├── logcatd         # systemd journal as a service
    └── proclogd        # Logs information from /proc
└── selfdrive           # Code needed to drive the car
    ├── assets          # Fonts, images, and sounds for UI
    ├── athena          # Allows communication with the app
    ├── boardd          # Daemon to talk to the board
    ├── car             # Car specific code to read states and control actuators
    ├── controls        # Planning and controls
    ├── debug           # Tools to help you debug and do car ports
    ├── locationd       # Precise localization and vehicle parameter estimation
    ├── loggerd         # Logger and uploader of car data
    ├── manager         # Deamon that starts/stops all other daemons as needed
    ├── modeld          # Driving and monitoring model runners
    ├── monitoring      # Daemon to determine driver attention
    ├── navd            # Turn-by-turn navigation
    ├── sensord         # IMU interface code
    ├── test            # Unit tests, system tests, and a car simulator
    └── ui              # The UI

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.


openpilot tests Total alerts Language grade: Python Language grade: C/C++ codecov